mirror of
https://github.com/gomods/athens
synced 2026-02-03 11:00:32 +00:00
Switching to using the main default branch (#1628)
* Switching to using the main default branch * changing links to main branch, not master branch * Changing a few links to relative * Bumping chart version Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
This commit is contained in:
Aaron Schlesinger
committed by
GitHub
GitHub
parent
f01c645305
commit
c2c5daf61a
@@ -7,7 +7,7 @@ weight: 3
|
||||
## Configuring Athens
|
||||
Here we'll cover how to configure the Athens application utilizing various configuration scenarios.
|
||||
|
||||
>This section covers some of the more commonly used configuration variables, but there are more! If you want to see all the configuration variables you can set, we've documented them all in [this configuration file](https://github.com/gomods/athens/blob/master/config.dev.toml).
|
||||
>This section covers some of the more commonly used configuration variables, but there are more! If you want to see all the configuration variables you can set, we've documented them all in [this configuration file](https://github.com/gomods/athens/blob/main/config.dev.toml).
|
||||
|
||||
### Authentication
|
||||
There are numerous version control systems available to us as developers. In this section we'll outline how they can be used by supplying required credentials in various formats for the Athens project.
|
||||
|
||||
@@ -341,7 +341,7 @@ It assumes that you already have the following:
|
||||
## External Storage
|
||||
|
||||
External storage lets Athens connect to your own implementation of a storage backend.
|
||||
All you have to do is implement the (storage.Backend)[https://github.com/gomods/athens/blob/master/pkg/storage/backend.go#L4] interface and run it behind an http server.
|
||||
All you have to do is implement the (storage.Backend)[https://github.com/gomods/athens/blob/main/pkg/storage/backend.go#L4] interface and run it behind an http server.
|
||||
|
||||
Once you implement the backend server, you must then configure Athens to use that storage backend as such:
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ weight: 4
|
||||
|
||||
Welcome, Gopher! We're really glad you're considering contributing to Athens. We'd like to briefly introduce you to our community before you get started.
|
||||
|
||||
We have some hard-and-fast rules in our community, like our [Code of Conduct](https://github.com/gomods/athens/blob/master/CODE_OF_CONDUCT.md), but instead of making rules pre-emptively, we try to keep in mind a shared philosophy to help us all make decisions and make new rules when we need to.
|
||||
We have some hard-and-fast rules in our community, like our [Code of Conduct](https://github.com/gomods/athens/blob/main/CODE_OF_CONDUCT.md), but instead of making rules pre-emptively, we try to keep in mind a shared philosophy to help us all make decisions and make new rules when we need to.
|
||||
|
||||
## Our Philosophy Document
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ weight: 2
|
||||
|
||||
This document lays out generally how we want to work with each other. It's hard to make a rule or set a guideline for each and every situation that might come up in our community. That's basically predicting the future!
|
||||
|
||||
We do of course set some boundaries like the [code of conduct](https://github.com/gomods/athens/blob/master/CODE_OF_CONDUCT.md), but we want to fall back to this document for guidance when we encounter a new situation or question that we need to address.
|
||||
We do of course set some boundaries like the [code of conduct](https://github.com/gomods/athens/blob/main/CODE_OF_CONDUCT.md), but we want to fall back to this document for guidance when we encounter a new situation or question that we need to address.
|
||||
|
||||
# Guiding Principles
|
||||
|
||||
|
||||
@@ -67,4 +67,4 @@ If any of this doesn't make sense, please contact us in the `#athens` channel in
|
||||
|
||||
Probably, yes! But we don't know if there are exact criteria on when PRs should be "prompted" and how a bot should do that. Maybe we'll learn those criteria here.
|
||||
|
||||
Even still, it's nice to have a human touch as a submitter and reviewer. It matches our [philosophy](https://github.com/gomods/athens/blob/master/PHILOSOPHY.md) very well.
|
||||
Even still, it's nice to have a human touch as a submitter and reviewer. It matches our [philosophy](https://github.com/gomods/athens/blob/main/PHILOSOPHY.md) very well.
|
||||
|
||||
@@ -20,8 +20,8 @@ request in The Athens Project.
|
||||
|
||||
---
|
||||
|
||||
Generally we will still want to try and follow the issue template for [bugs](https://github.com/gomods/athens/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) or
|
||||
[features](https://github.com/gomods/athens/blob/master/.github/ISSUE_TEMPLATE/feature_request.md). If you are performing issue triage you may need to add more
|
||||
Generally we will still want to try and follow the issue template for [bugs](https://github.com/gomods/athens/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) or
|
||||
[features](https://github.com/gomods/athens/blob/main/.github/ISSUE_TEMPLATE/feature_request.md). If you are performing issue triage you may need to add more
|
||||
information to fulfill the below template.
|
||||
|
||||
## Template
|
||||
|
||||
@@ -9,7 +9,7 @@ The proxy is written in idiomatic Go and uses standard tools. If you know Go, yo
|
||||
|
||||
Athens uses [Go Modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) for dependency management. You will need [Go v1.12+](https://golang.org/dl) to get started on Athens.
|
||||
|
||||
See our [Contributing Guide](https://github.com/gomods/athens/blob/master/CONTRIBUTING.md) for tips on how to submit a pull request when you are ready.
|
||||
See our [Contributing Guide](https://github.com/gomods/athens/blob/main/CONTRIBUTING.md) for tips on how to submit a pull request when you are ready.
|
||||
|
||||
### Go version
|
||||
Athens is developed on Go v1.12+.
|
||||
|
||||
@@ -16,4 +16,4 @@ Contributing to docs is just as important, if not more important than, writing c
|
||||
|
||||
The Hugo server will run on http://localhost:1313 and it will automatically watch your files and update the website every time you make a change.
|
||||
|
||||
Alternatively you can run our custom docker image as outlined [here](https://github.com/gomods/athens/blob/master/DEVELOPMENT.md#run-the-docs)
|
||||
Alternatively you can run our custom docker image as outlined [here](./DEVELOPMENT.md#run-the-docs)
|
||||
@@ -45,7 +45,7 @@ Book.
|
||||
commit them to the log we mentioned. You have a few options for writing a
|
||||
message that will be stored with the commit in the log, more on that later.</dd>
|
||||
<dt>Branch</dt>
|
||||
<dd>When you are in the repository the default is usually called master,
|
||||
<dd>When you are in the repository the default out of the box is usually called `master`. This is the main branch of the repository (NOTE: if you are creating a new repository of your own, please change the default branch to `main`. `master` is an inappropriate and offensive),
|
||||
the main branch of the repository. Typically you will want to do your work
|
||||
on a new branch for each feature or bug. This allows you to see and work on
|
||||
different versions of the same code in one repository.</dd>
|
||||
@@ -53,9 +53,7 @@ Book.
|
||||
<dd>To check out a branch, is to switch to view that branches version of the
|
||||
files in the repository.</dd>
|
||||
<dt>Merge</dt>
|
||||
<dd>When you want to incorporate another branch, master or someone else's
|
||||
feature for example, into your current branch you will merge the changes. This will apply
|
||||
the other changes on top of yours.
|
||||
<dd>When you want to incorporate another branch, `main` or someone else's feature for example, into your current branch you will merge the changes. This will apply the other changes on top of yours.
|
||||
<dt>Remote</dt>
|
||||
<dd>This is just a repository, that is accessible remotely. You can use the
|
||||
git command to push and pull changes to.</dd>
|
||||
|
||||
@@ -72,9 +72,7 @@ pull request. You can discuss the changes requested in the pull request itself,
|
||||
or if you need help with something in particular you can reach out to us in the
|
||||
`#athens` channel on [Gophers Slack](https://gophers.slack.com).
|
||||
|
||||
After all requested changes are resolved a maintainer will give it a final look
|
||||
and as long as our continuous integration passed they will merge it with the
|
||||
master branch.
|
||||
After all requested changes are resolved a maintainer will give it a final look and as long as our continuous integration passed they will merge it with the `main` branch.
|
||||
|
||||
#### Project process
|
||||
|
||||
@@ -101,7 +99,7 @@ straight the pull request.
|
||||
##### Open a pull request
|
||||
|
||||
After you have created a branch on your fork, and made the changes. Please make
|
||||
sure all tests still pass, see [DEVELOPMENT.md](https://github.com/gomods/athens/blob/master/CONTRIBUTING.md#verify-your-work) for details. Then after you push all changes
|
||||
sure all tests still pass, see [DEVELOPMENT.md](https://github.com/gomods/athens/blob/main/CONTRIBUTING.md#verify-your-work) for details. Then after you push all changes
|
||||
up to your fork, head over to [Athens](https://github.com/gomods/athens) to open a pull request. Usually,
|
||||
right after you have pushed a new branch and you visit the original repository,
|
||||
GitHub will prompt you to open a new pull request. Otherwise you can do so from
|
||||
|
||||
@@ -121,7 +121,7 @@ For more information, see [Managing Compute Resources for Containers](https://ku
|
||||
### Give Athens access to private repositories via Github Token (Optional)
|
||||
|
||||
1. Create a token at https://github.com/settings/tokens
|
||||
2. Provide the token to the Athens proxy either through the [config.toml](https://github.com/gomods/athens/blob/master/config.dev.toml) file (the `GithubToken` field) or by setting the `ATHENS_GITHUB_TOKEN` environment variable.
|
||||
2. Provide the token to the Athens proxy either through the [config.toml](https://github.com/gomods/athens/blob/main/config.dev.toml) file (the `GithubToken` field) or by setting the `ATHENS_GITHUB_TOKEN` environment variable.
|
||||
|
||||
### Storage Providers
|
||||
|
||||
|
||||
@@ -120,7 +120,7 @@ helm install gomods/athens-proxy -n athens --namespace athens \
|
||||
### 通过Github令牌(Token)授予athens访问私有存储库的权限（可选）
|
||||
|
||||
1. 在 https://github.com/settings/tokens 上创建一个令牌(Token)
|
||||
2. 通过 [config.toml](https://github.com/gomods/athens/blob/master/config.dev.toml) 文件 ( `GithubToken` 字段) 或 通过设置`ATHENS_GITHUB_TOKEN` 环境变量，将令牌提供给Athens代理.
|
||||
2. 通过 [config.toml](https://github.com/gomods/athens/blob/main/config.dev.toml) 文件 ( `GithubToken` 字段) 或 通过设置`ATHENS_GITHUB_TOKEN` 环境变量，将令牌提供给Athens代理.
|
||||
|
||||
### 存储提供程序（storage provider）
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@ Whether setting Athens up using [Kubernetes](./install-on-kubernetes) or using t
|
||||
|
||||
The Athens project produces two docker images, available via [Docker Hub](https://hub.docker.com/)
|
||||
|
||||
1. A release version as [`gomods/athens`](https://hub.docker.com/gomods/athens), each tag corresponds with an Athens [release](https://github.com/gomods/athens/releases), e.g. `v0.7.1`. Additionally, a `canary` tag is available and tracks each commit to `master`
|
||||
2. A tip version, as [`gomods/athens-dev`](https://hub.docker.com/r/gomods/athens-dev), tagged with every commit to `master`, e.g. `1573339`
|
||||
1. A release version as [`gomods/athens`](https://hub.docker.com/gomods/athens), each tag corresponds with an Athens [release](https://github.com/gomods/athens/releases), e.g. `v0.7.1`. Additionally, a `canary` tag is available and tracks each commit to `main`
|
||||
2. A tip version, as [`gomods/athens-dev`](https://hub.docker.com/r/gomods/athens-dev), tagged with every commit to `main`, e.g. `1573339`
|
||||
|
||||
For a detailed tags list, check each image's Docker Hub
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ The Go community has had lots of problems with libraries disappearing or changin
|
||||
|
||||
### Logic
|
||||
|
||||
The fact that the Go command line can now ping _your own_ server to download dependencies, that means you can program whatever logic you want around providing such dependencies. Things like Access Control (discussed below), adding custom versions, custom forks, and custom packages. For example, Athens provides a [Validation Hook](https://github.com/gomods/athens/blob/master/config.dev.toml#L127) that will get called for every module download to determine whether a module should be downloaded or not. Therefore, you can extend Athens with your own logic such as scanning a module path or code for red flags etc.
|
||||
The fact that the Go command line can now ping _your own_ server to download dependencies, that means you can program whatever logic you want around providing such dependencies. Things like Access Control (discussed below), adding custom versions, custom forks, and custom packages. For example, Athens provides a [Validation Hook](https://github.com/gomods/athens/blob/main/config.dev.toml#L127) that will get called for every module download to determine whether a module should be downloaded or not. Therefore, you can extend Athens with your own logic such as scanning a module path or code for red flags etc.
|
||||
|
||||
|
||||
### Performance
|
||||
|
||||
@@ -22,7 +22,7 @@ Athens通过将代码从VCS复制到_不可变_存储中来解决这些问题。
|
||||
|
||||
### 逻辑
|
||||
|
||||
go命令行现在可以ping _您自己的服务器_ 来下载依赖项，这意味着您可以编写任何需要的逻辑来提供这种依赖项。包括访问控制（下面将讨论）、添加自定义版本、自定义分支和自定义包等。例如，Athens提供了一个[验证钩子（hook）](https://github.com/gomods/athens/blob/master/config.dev.toml#L127)，每个模块下载时都会调用它来确定是否应该下载此模块。因此，您可以用自己的逻辑扩展athens，比如扫描模块路径或代码以查找标红代码等。
|
||||
go命令行现在可以ping _您自己的服务器_ 来下载依赖项，这意味着您可以编写任何需要的逻辑来提供这种依赖项。包括访问控制（下面将讨论）、添加自定义版本、自定义分支和自定义包等。例如，Athens提供了一个[验证钩子（hook）](https://github.com/gomods/athens/blob/main/config.dev.toml#L127)，每个模块下载时都会调用它来确定是否应该下载此模块。因此，您可以用自己的逻辑扩展athens，比如扫描模块路径或代码以查找标红代码等。
|
||||
|
||||
|
||||
### 性能
|
||||
|
||||
Reference in New Issue
Block a user