Merge remote-tracking branch 'refs/remotes/origin/aws-sdk-go-v2' into…

… aws-sdk-go-v2

README.md

@@ -10,7 +10,7 @@
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
 [![Open Source Helpers](https://www.codetriage.com/gomods/athens/badges/users.svg)](https://www.codetriage.com/gomods/athens)
 
-Welcome to the Athens project! We are a proxy server for the [Go Modules download API](https://docs.gomods.io/intro/protocol/).
+Welcome to the Athens project! Athens is an open source, enterprise ready implementation of the [Go Module proxy](https://go.dev/ref/mod#module-proxy) for the [Go Modules download API](https://docs.gomods.io/intro/protocol/).
 
 See our documentation site [https://docs.gomods.io](https://docs.gomods.io) for more details on the project.
 
@@ -74,8 +74,7 @@ If you're not ready to contribute code yet, there are plenty of other great ways
 
 # Built on the Shoulders of Giants
 
-The Athens project would not be possible without the amazing projects it builds on. Please see
-[SHOULDERS.md](./SHOULDERS.md) to see a list of them.
+The Athens project would not be possible without the amazing projects it builds on. Please see [SHOULDERS.md](./SHOULDERS.md) to see a list of them.
 
 # Coding Guidelines
 
@@ -92,4 +91,5 @@ If you have concerns, notice a code of conduct violation, or otherwise would lik
 related to this code of conduct, please reach out `@arschles` on the [Gophers Slack](https://gophers.slack.com/).
 
 ---
+
 Athens banner attributed to Golda Manuel

docs/Dockerfile

@@ -1,6 +1,6 @@
 FROM alpine:3.8 as builder
 
-ARG HUGO_VERSION=0.72.0
+ARG HUGO_VERSION=0.125.1
 ENV HUGO_BINARY=hugo_${HUGO_VERSION}_Linux-64bit.tar.gz
 
 ADD https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/${HUGO_BINARY} /tmp

docs/assets/css/theme-athens.css

@@ -0,0 +1,42 @@
+/* my-custom-variant */
+:root {
+  --PRIMARY-color: rgb( 9, 7, 112 ); /* brand primary color */
+  --SECONDARY-color: rgb( 9, 7, 112 ); /* brand secondary color */
+  --ACCENT-color: rgb( 64, 62, 150 ); /* brand accent color, used for search highlights */
+  --MAIN-LINK-color: rgb( 68, 66, 165 ); /* link color of content */
+  --MAIN-LINK-HOVER-color: rgb( 68, 66, 165 ); /* hoverd link color of content */
+  --MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* background color of content */
+  --MAIN-TEXT-color: rgba( 50, 50, 50, 1 ); /* text color of content and h1 titles */
+  --MAIN-TITLES-TEXT-color: rgba( 94, 94, 94, 1 ); /* text color of h2-h6 titles and transparent box titles */
+  --MAIN-TITLES-H1-color: rgba( 34, 34, 34, 1 ); /* text color of h1 titles */
+  --CODE-theme: learn; /* name of the chroma stylesheet file */
+  --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback text color of block code; should be adjusted to your selected chroma style */
+  --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback background color of block code; should be adjusted to your selected chroma style */
+  --CODE-BLOCK-BORDER-color: rgba( 40, 42, 54, 1 ); /* border color of block code */
+  --CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* text color of inline code */
+  --CODE-INLINE-BG-color: rgba( 255, 247, 221, 1 ); /* background color of inline code */
+  --CODE-INLINE-BORDER-color: rgba( 251, 240, 203, 1 ); /* border color of inline code */
+  --MENU-HEADER-BG-color: rgb( 9, 7, 112 ); /* background color of menu header */
+  --MENU-HEADER-BORDER-color: rgb( 64, 62, 150 ); /* border color between menu header and menu */
+  --MENU-HOME-LINK-color: rgba( 224, 224, 224, 1 ); /* home button color if configured */
+  --MENU-HOME-LINK-HOVER-color: rgba( 240, 240, 240, 1 ); /* hoverd home button color if configured */
+  --MENU-SEARCH-color: rgba( 255, 255, 255, 1 ); /* text and icon color of search box */
+  --MENU-SEARCH-BG-color: rgb( 64, 62, 150 ); /* background color of search box */
+  --MENU-SEARCH-BORDER-color: rgb( 64, 62, 150 ); /* border color of search box */
+  --MENU-SECTIONS-BG-color: rgba( 43, 42, 56, 1 ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
+  --MENU-SECTIONS-ACTIVE-BG-color: rgba( 32, 31, 41, 1 ); /* background color of the active menu section */
+  --MENU-SECTIONS-LINK-color: rgba( 204, 204, 204, 1 ); /* link color of menu topics */
+  --MENU-SECTIONS-LINK-HOVER-color: rgba( 230, 230, 230, 1 ); /* hoverd link color of menu topics */
+  --MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 119, 119, 119, 1 ); /* text color of the displayed menu topic */
+  --MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba( 255, 255, 255, 1 ); /* background color of the displayed menu topic */
+  --MENU-SECTION-SEPARATOR-color: rgba( 42, 35, 47, 1 ); /* separator color between menu sections and menu footer */
+  --MENU-VISITED-color: rgba( 0, 189, 243, 1 ); /* icon color of visited menu topics if configured */
+  --BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* text color of colored box titles */
+  --BOX-BG-color: rgba( 255, 255, 255, .833 ); /* background color of colored boxes */
+  --BOX-TEXT-color: rgba( 16, 16, 16, 1 ); /* text color of colored box content */
+  --BOX-BLUE-color: rgb( 201, 238, 255 ); /* background color of blue boxes */
+  --BOX-GREEN-color: rgb( 179, 229, 190 ); /* background color of green boxes */
+  --BOX-GREY-color: rgb( 170, 119, 255 ); /* background color of grey boxes */
+  --BOX-ORANGE-color: rgb( 255, 184, 76 ); /* background color of orange boxes */
+  --BOX-RED-color: rgb( 241, 103, 103 ); /* background color of red boxes */
+}

docs/config.toml

@@ -1,5 +1,5 @@
 baseURL = "https://docs.gomods.io"
-theme = "hugo-theme-learn"
+theme = "hugo-theme-relearn"
 languageCode = "en-us"
 title = "Athens"
 
@@ -18,8 +18,65 @@ title = "Athens"
 
 
 [params]
-disableShortcutsTitle = true
-disableInlineCopyToClipBoard = true
+  disableShortcutsTitle = true
+  disableInlineCopyToClipBoard = true
+  # Extension to the image effects only for the docs.
+  imageEffects.bg-white = true
+  editURL = 'https://github.com/gomods/athens/edit/main/docs/content/${FilePath}'
+  titleSeparator = '-'
+  additionalContentLanguage = ['en', 'zh', 'es']
+  themeVariant = [{ identifier = "athens" },]
 
 [outputs]
-home = [ "HTML", "RSS", "JSON"]
+  # add `json` to the home to support Lunr search; This is a mandatory setting
+  # for the search functionality
+  # add `print` to home, section and page to activate the feature to print whole
+  # chapters
+  home = ["html", "rss", "print", "search", "searchpage"]
+  section = ["html", "rss", "print"]
+  page = ["html", "rss", "print"]
+
+[markup]
+  [markup.highlight]
+    # line numbers in a table layout will shift if code is wrapping, so better
+    # not use it; visually both layouts have the same look and behavior
+    lineNumbersInTable = false
+
+    # the shipped variants come with their own modified chroma syntax highlighting
+    # stylesheets which are linked in your generated HTML pages; you can use Hugo to generate
+    # own stylesheets to your liking and use them in your variant;
+    # if you want to use Hugo's internal styles instead of the shipped stylesheets:
+    # - remove `noClasses` or set `noClasses = true`
+    # - set `style` to a predefined style name
+    # note: with using the internal styles, the `--CODE-theme` setting in your variant
+    # stylesheet will be ignored and the internal style is used for all variants and
+    # even print
+    noClasses = false
+    # style = "tango"
+
+  [markup.goldmark]
+    # this is required for the themes exampleSite to make the piratify shortcode work
+    duplicateResourceFiles = true
+
+    # activated for this showcase to use HTML and JavaScript; decide on your own needs;
+    # if in doubt, remove this line
+    renderer.unsafe = true
+
+  [markup.goldmark.extensions]
+
+    [markup.goldmark.extensions.passthrough]
+      enable = true
+
+      [markup.goldmark.extensions.passthrough.delimiters]
+        # the settings chosen here match the default initialization
+        # of the MathJax library chosen by the theme;
+        # if you want to adjust to different values you also need
+        # to set them in `[params] mathJaxInitialize`
+        inline = [['\(', '\)'], ['$',  '$']]
+        block  = [['\[', '\]'], ['$$', '$$']]
+
+[[menu.shortcuts]]
+    name = "<i class='fa-fw fab fa-github'></i> GitHub repo"
+    identifier = "ds"
+    url = "https://github.com/gomods/athens"
+    weight = 10

docs/content/_index.md

@@ -7,47 +7,28 @@ date: 2018-12-07T11:44:36+00:00
 
 ## Athens is a Server for Your Go Packages
 
-Welcome, Gophers! We're looking forward to introducing you to Athens..
-
-On this site, we document Athens in detail. We'll teach you what it does, why it matters, what you can do with it, and how you can run it yourself. Below is a brief summary for you.
+Welcome, Gophers! Athens is an open source enterprise ready [Go Module proxy](https://go.dev/ref/mod#module-proxy) with extensive configuration for a variety of online and offline usecases. 
+It is in use for anti-censorship, compliance, data privacy, and data continuity usecases in homes and corporations across the globe today.
 
 #### How To Get Started?
-    Run `docker run -p '3000:3000' gomods/athens:latest`
+Run `docker run -p '3000:3000' gomods/athens:latest`
 
 Then, set up your `GOPROXY` and `go get` going!
 
     export GOPROXY=http://localhost:3000 && go get module@v1
 
-#### What Does Athens Do?
-
-Athens provides a server for [Go Modules](https://github.com/golang/go/wiki/Modules) that you can run. It serves public code and your private code for you, so you don't have to pull directly from a version control system (VCS) like GitHub or GitLab.
-
-#### Why does it matter? 
-
-There are many reasons why you'd want a proxy server such as security and performance. [Take a look](/intro/why) at a few of them
-
-#### How Do I Use It?
+When you're ready to run something more production ready, Athens can run on on a variety of platforms including [AWS, Azure, GCP, Digital Ocean, Alibaba, and bare metal](./install/).
 
-Athens is easy to run yourself. We give you a few options:
-
-- You can run it as a binary on your system
-    - Instructions coming soon for this
-- You can run it as a [Docker](https://www.docker.com/) image (see [here](./install/shared-team-instance/) for how to do that)
-- You can run it on [Kubernetes](https://kubernetes.io) (see [here](./install/install-on-kubernetes/) for how to do that)
-
-We also run an experimental version of Athens so you can get started without even installing anything. To get started, set `GOPROXY="https://athens.azurefd.net"`.
-
->This is not a production-ready proxy deployment, though. Please deploy your own Athens instance for your builds. _If you need a hosted proxy for public code, consider using either `https://gocenter.io` or `https://proxy.golang.org`_.
-
-**[Like what you hear? Try Athens Now!](/try-out)**
+#### What Does Athens Do?
 
+Athens is an implementation of the [Go Module proxy](https://go.dev/ref/mod#module-proxy). Go clients talk to Athens to retrieve packages at its most basic level. 
+Athens supports [many usecases](./intro/why) on top of that basic premise.
 
 ## Not Ready to try Athens Yet?
 
 Here are some other ways to get involved:
 
-- Read the full [walkthrough](/walkthrough) with setting up, running and testing the Athens proxy
-explores this in greater depth.
+* Read the full [walkthrough](/walkthrough) with setting up, running and testing the Athens proxy explores this in greater depth.
 * Join our [office hours](/contributing/community/office-hours/)! It's a great way to meet folks working on the project, ask questions or just hang out. All are welcome to join and participate.
 * Check out our issue queue for [good first issues](https://github.com/gomods/athens/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
 * Join us in the `#athens` channel on the [Gophers Slack](https://invite.slack.golangbridge.org/)

docs/content/configuration/logging.md

@@ -0,0 +1,15 @@
+---
+title: Logging
+description: Configure the logger for your desired output
+weight: 9
+---
+
+Athens is designed to support a myriad of logging scenarios.
+
+## Standard
+
+The standard structured logger can be configured in `plain` or `json` formatting via `LogFormat` or `ATHENS_LOG_FORMAT`. Additionally, verbosity can be controlled by setting `LogLevel` or `ATHENS_LOG_LEVEL`. In order for the standard structured logger to work, `CloudRuntime` and `ATHENS_CLOUD_RUNTIME` should not be set to a valid value.
+
+## Runtimes
+
+Athens can be configured according to certain cloud provider specific runtimes. The **GCP** runtime configures Athens to rename certain logging fields that could be dropped or overriden when running in a GCP logging environment. This runtime can be used with `LogLevel` or `ATHENS_LOG_LEVEL` to control the verbosity of logs.

docs/content/contributing/community/_index.md

@@ -6,8 +6,6 @@ weight: 1
 
 ---
 
-# The Athens Community
-
 Welcome, Athenian! We've put together this section to help you get involved with the Athens community.
 
 Before we go further, we want you to know two things:

docs/content/contributing/community/participating.md

@@ -75,35 +75,8 @@ please reach out to one or more of the contributors or maintainers.
 # Maintainers
 
 After you become a contributor, you'll have the opportunity to become a
-maintainer.
-Here's what being a maintainer means and how to become one.
-
-_Note: We sometimes refer to maintainers as "core maintainers," but they're
-the same thing._
-
-## What Being a Maintainer Means
-
-As a maintainer, you'll be doing the same things as a contributor with a few
-extras:
-
-- Help organize our development meetings (i.e. help organize the agenda)
-- Promote the project and build community (e.g. present on it where possible,
-write about it, ...) when possible<sup>2</sup>
-- Triage issues (e.g. adding labels, promoting discussions, finalizing
-decisions)
-- Organize and promote PR reviews (e.g. prompting community members,
-contributors, and other maintainers to review)
-- Help foster a safe and welcoming environment for all project participants.
-This will include enforcing our code of conduct. We adhere to the [Contributor
-Covenant](https://www.contributor-covenant.org), if you haven't read it yet you can do so [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct) (english version).
-
-## How to Become a Maintainer
-
-To become a maintainer, we would like you to see you be an effective
-contributor, and show that you can do some of the things maintainers do.
-Maintainers will do their best to regularly discuss promoting contributors.
-But don't be shy, if you feel that this is you, please reach out to one or
-more of the maintainers.
+maintainer. If you're happy with your contributions but want more of a role in
+steering the project then read more on [being a maintainer](./contributing/maintainers).
 
 # The End
 

docs/content/contributing/maintainers/first-issues.md → docs/content/contributing/first-issues.md

@@ -1,8 +1,6 @@
 ---
 title: "Good First Issues"
 date: 2018-09-02T10:00:00-07:00
-LastModifierDisplayName: "Robbie"
-LastModifierEmail: "hello@robloranger.ca"
 
 ---
 

docs/content/contributing/maintainers/_index.md

@@ -1,16 +1,42 @@
 ---
 title: "Maintainers"
 date: 2018-09-28T10:40:50-07:00
-chapter: true
 weight: 3
 
 ---
 
-### Contributing
+There are [a lot of ways to contribute to the Athens project](./participating) and being a maintainer is only one of those paths. Maintainers on the Athens Project are expected to
+devote roughly five hours a week to the development and maintenance of the project. Their responsibilities include:
 
-# Maintainers
+- Help organize our development meetings (i.e. help organize the agenda)
+- Promote the project and build community (e.g. present on it where possible,
+write about it, ...) when possible<sup>2</sup>
+- Triage issues (e.g. adding labels, promoting discussions, finalizing
+decisions)
+- Organize and promote PR reviews (e.g. prompting community members,
+contributors, and other maintainers to review)
+- Help foster a safe and welcoming environment for all project participants.
+This will include enforcing our code of conduct. We adhere to the [Contributor
+Covenant](https://www.contributor-covenant.org), if you haven't read it yet you can do so [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct) (english version).
 
-These pages outline the responsibilities for project maintainers. We
-want all community members to understand why we make the decisions we do, and
-what sort of templates or guides we follow.
+We'd love to have your partnership in building Athens, but it is a statement to the commitment that a project of Athens' size and
+complexity demands. If that appeals to you [join us on Slack](https://gophers.slack.com/archives/C9LRAQN8N).
 
+## Benefits of being a maintainer
+
+- Free access to GitHub CoPilot
+- A rewarding sense of accomplishment
+- Fun, complex work in a safe and collaborative environment
+- Access to very smart people
+
+
+
+## Contributing without maintaining
+
+If maintaining Athens isn't something you can do, we're always looking for people to:
+- Develop features
+- Patch bugs
+- Triage issues
+- Provide support
+
+You don't need to do anything other than visit our [GitHub page](https://github.com/gomods/athens) to do all of the above!

docs/content/faq.md

@@ -1,7 +1,6 @@
 ---
 title: FAQ
 description: Frequently Asked Questions
-menu: shortcuts
 ---
 
 ### Is Athens Just a Proxy? A Registry?

docs/content/try-out.md

@@ -1,7 +1,6 @@
 ---
 title: Try it out!
 description: How to see Athens in action 
-menu: shortcuts
 ---
 
 ## Try out Athens

docs/content/walkthrough.md

@@ -1,7 +1,6 @@
 ---
 title: Walkthrough
 description: Understanding the Athens proxy and Go Modules
-menu: shortcuts
 ---
 
 First, make sure you have [Go v1.12+ installed](https://gophersource.com/setup/) and that GOPATH/bin is on your path.