Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add docs about network mode #1873

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: add docs about network mode #1873

wants to merge 6 commits into from

Conversation

ngshiheng
Copy link
Contributor

@ngshiheng ngshiheng commented May 17, 2023 •
edited
Loading

What is the problem I am trying to address?

  • Added some documentation for Athens' Network Mode configuration
  • Added some use cases for each network mode
  • Fixed the "Fork me on GitHub" ribbon
  • Fixed some broken links
  • Updated helm CLI installation instruction

To run this locally, just check out this branch and run hugo serve -s docs at the repository root.

@ngshiheng ngshiheng requested a review from a team as a code owner May 17, 2023 14:12
@ngshiheng ngshiheng added the docs improvements/changes to our documentation label May 17, 2023
@ngshiheng
Copy link
Contributor Author

@marwan-at-work can you help to take a look at this PR for docs update? I think you have the most context about Athens NetworkMode

marwan-at-work
marwan-at-work reviewed May 30, 2023
View reviewed changes
docs/content/configuration/network.md

2. `offline`: This mode only retrieves versions from Athens' storage and never reaches out to the VCS.

3. `fallback`: This mode retrieves versions from Athens' storage only if the VCS fails. Note that using this mode may result in inconsistent results since fallback mode does its best to provide the available versions at the time of the request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This mode retrieves versions from Athens' storage only if the VCS fails.

I don't believe that's true. We always retrieve versions from the Athens storage. We just fallback to only providing this list in case of an upstream outage

Copy link
Contributor Author

@ngshiheng ngshiheng May 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We always retrieve versions from the Athens storage

Hmm sorry, I don't exactly follow

  1. This was taken from this snippet.
  2. That aside, I can attest this behavior is correct based on existing live deployments
  3. Also referring to /pkg/download/protocol.go

maybe I could have worded it better? 🤔

edit: AFAIK go get will reach out to VCS to retrieve versions. But commands like go mod download and go build will always return whatever that is from Athens storage

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marwan-at-work WDYT? can you recommend what can I change here to move this PR forward?

@ngshiheng ngshiheng force-pushed the add-network-mode-docs branch from 9306eee to e0a7805 Compare July 3, 2023 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marwan-at-work marwan-at-work marwan-at-work left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs improvements/changes to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ngshiheng @marwan-at-work