Commit Graph

37 Commits

Author SHA1 Message Date
Gil
4123c32222 Add documentation to setup netrc when using proxy with private repositories. (#712)
* changed base to use 1.11-alpine and addded GO111MODULE=on to environment

* change go build to be one line with modules on

* add vcs systems that were in original stretch image

* created multistage build with copy from and path environment update

* added env GO111MODULE=on

* add and run create default, prereq bash installed, moved go binary, created GOROOT path

* update to preferred docker entry point and shorter config path

* added fossil and info to links for compare of VCS

* Add section to Authenticate via .netrc

Authenticate private repositories via .netrc on Docker Image

* Update to simplify text

changed to simplify and add defaults for Athens
2018-10-01 14:16:57 -04:00
Rob j Loranger
89c09b11f8 docs: contribution guides (#570)
* starting outline

* Rewording and adding more outline

* moar

* remove maintainers links, fill in template links

* basic list of ideas

* change folder structure

* try out new menu and page heiarchy

* thinking out loud

* I like this link

* almost done for now

* move into new sub menu

* doesn't belong here

* trigger netlify

* forgot chapter flag

* capitalize

* comment out ideas

* basic outline of git

* not a draft anymore

* git and github complete

* move community roles and order menu

* typos and link contributor covenant

* address requested changes

remove last mod time and author from chapters
re-phrase leading line in docs/maintainers/_index.md
2018-09-28 11:29:56 -07:00
Manu Gupta
187ab9da8b Add observability docs how-to in faq (#702)
* Add observability how-to in faq

* Add  a bit more info

* Try with smaller font size

* update language and add a link

* cleaning the sins of copy and paste

* Fix docker-compose location

* Make the language clearer
2018-09-26 14:09:37 -07:00
Marwan Sulaiman
e574d28efd Remove config flag from walkthrough doc (#692) 2018-09-20 22:48:46 +02:00
marpio
bcc896f226 rename example to dev and rm test config (#691) 2018-09-20 16:38:08 -04:00
dapchen
2b6eed3875 [protocol]: fix texts and examples in the protocol doc (#605)
* [protocol]: fix texts and examples in the protocol doc

* update examples

* address review comment
2018-09-17 12:51:28 +02:00
Rohan Chakravarthy
0e470d0294 Plumb config - Latest (#627)
* switch proxy to config file

pull in single flight changes

* changes for single-flight

* intermediate stage. All tests passing. pkg still has env refs

* remove all env references

* delete config/env entirely

* fix failing tests

* create the config.toml file as part of dev setup

* create config file only if it doesn't exist

* update Dockerfiles to use config file

* move composing elements to the top

* verbose parameter naming

* newline

* add flag for config file path

* update docs with config file flag

* remove unnecessary nil check

* use filepath.join

* rename redis port to address

* fix path.join

* fix issues after merge

* add vendor dir
2018-09-11 15:04:20 -07:00
Jayakrishna Sahit
a076b0c4d8 fix for #626 (#629)
* fix for #626

* Added pid method
2018-09-10 14:16:14 -07:00
lpdyck
a2a2d93a9e [walkthrough]: add powershell walkthrough (#598)
* add powershell commands

* split the semicolon onto two lines instead

* split another semicolon onto two lines instead

* remove does not work on windows warning

* fix powershell typo

* fix type in modules enables not supported notification

* use start-process instead of start
2018-09-01 11:53:30 +02:00
Michael Cook
ea1503f071 minor spelling fix (#603) 2018-08-30 17:26:03 -06:00
dapchen
f96d1f838b [protocol]: update examples to use working links (#599)
* [protocol]: update examples to use working links

* Change to use $HOST and $PORT as placeholders.
2018-08-30 16:50:10 -06:00
Kent Rancourt
992ee933eb [walkthrough]: adjust instructions to clone athens on gopath (#593)
* [walkthrough]: adjust instructions to clone athens on gopath

* Update walkthrough.md
2018-08-30 16:27:22 -06:00
Kent Rancourt
3a76afb6a6 [walkthrough]: Fix errant reference to (no used) vendor directory (#591) 2018-08-30 16:05:45 -06:00
Kent Rancourt
0e411d77e3 [walkthrough]: fix incorrect env var (#592) 2018-08-30 15:58:05 -06:00
Komu Wairagu
69a5340c91 update to go1.11 (#563)
* update travis to Go 1.11

* update check_deps ci script
ci for checking dependencies should now check Go module files and use go mod verify

* remove uneeded comment

* set GO111MODULE

* debug GO111MODULE propagation

* rm dep installation

* debug GO111MODULE propagation

* rm debug statements

* use Go point releases in ci

* remove references to Go1.11 RCs

* run ci with GO111MODULE auto and also on

* use matrix
2018-08-28 08:46:12 +02:00
Jeremy Rickard
a953f1121b Finishing up the helm chart (#547)
* chart skeleton

* doing more stuff on templates

* Adding disk storage root env var

In case you set the storage type to disk, then you can set the storage root

* Defaulting disk storage root location

* defaulting to go binary path as installed in dockerfile

* Adding Adding Service and Ingress to Chart

* In sync with newer docker image, added the ability to use a PVC!

* Refactored charts, added skeleton install

Co-authored-by: Aaron Schlesinger <arschles@gmail.com>

* Adding more documentation

* Adding newlines

* Updated to v0.1.0 !!!

* Updated repo to gomods/proxy
2018-08-27 09:55:38 -06:00
Jeremy Rickard
7962cac0c2 How to install a shared dev team instance with persistent storage (#543)
* WIP "installation" guide

This PR adds an installation guide with instructions on how to use
disk storage to achieve persistent storage.

Closes #533

* Formatting cleanup

* Swapped to Docker based instructions

* Moved install into "install" directory, added PowerShell commands

* Fixed wording about running container and environment variables

* Fixed a type-o

* Code review comments, cleaned up PowerShell commands

* Updated docker run commands

* WIP "installation" guide

This PR adds an installation guide with instructions on how to use
disk storage to achieve persistent storage.

Closes #533

* Formatting cleanup

* Swapped to Docker based instructions

* Moved install into "install" directory, added PowerShell commands

* Fixed wording about running container and environment variables

* Fixed a type-o

* Code review comments, cleaned up PowerShell commands

* Updated docker run commands

* Update to gomods/proxy:latest
2018-08-27 09:20:41 -06:00
Rob j Loranger
0f218d0347 disable inline copy to clipboard (#565) 2018-08-27 09:10:52 -06:00
Aaron Schlesinger
53f457e0b8 Rough description of community roles (#444)
* Rough description of community roles

and how to move to new roles

* add mention of CoC

* fixing typo

* adding link to past dev meetings

* moving "core maintainer" alias text

* calling out specifically that contributors have read access

* formatting

* Addressed previous concerns.

Broke all markdown lines on or under 80 chars because vim, also the
majority of the doc was formatted that way.

* link to slack re: missing meetings

* use emphasis instead of single quote for 'don't know enough'

* use code element in html

* expand on CoC duty

co-authored-by: Aaron Schlesinger <arschles@gmail.com>
co-authored-by: robjloranger <robjloranger@protonmail.com>
2018-08-26 19:07:22 -05:00
Carolyn Van Slyck
7c137a736b Document proxy authentication in the FAQ (#541)
* Document proxy authentication in the FAQ

* Fix typo
2018-08-24 11:04:06 -05:00
Michal Pristas
44ec04dd4d updated to rc2 (#557) 2018-08-23 08:09:10 +02:00
Manu Gupta
3a8c6429e9 Removal of cdn rdbms driver and pop support from olympus (#551)
* Inital removal of cdn rdbms driver and pop support from olympus

* Update travis and other unit test scripts

* Remove postgres from Makefile

* Update comments and remove function that is not required

* Update .env file

* clean commented code

* Update docs to remove references to rdbms

* Remove pop and run dep ensure to make sure that the tests pass without pop

* Keeping GO_ENV=test for parametter logging
2018-08-22 20:10:19 +02:00
Carolyn Van Slyck
2f28dc9e51 Tweak homepage theme (#542)
* Make athens banner smaller

This helps people see that there is more content below the athens logo, otherwise
the most prominent thing they see is the next arrow >
and they miss our homepage content.

* Make home link friendly for previews

Right now when viewing a preview of our docs site, when I click on the home logo
I end up on our live site. This makes the home logo go to the root of the
current site instead, which is more friendly for testing docs locally
or previewing a PR.
2018-08-21 13:59:16 -05:00
Carolyn Van Slyck
af7f1a6eda Walkthrough how the proxy works (#505)
* Walkthrough how the proxy and modules work

This is just the second step in adding in more docs. After we add more
docs for how to install the proxy, etc this doc will get updated with a
Next Steps section and point people in the right direction after they
try it out.

* Replace cache with storage when referring to the proxy

It is still the right term for the on-disk go modules cache in GOPATH/pkg/mod though

co-authored-by: Jeremy Rickard <jeremy.rickard@microsoft.com>
co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
2018-08-21 10:00:00 -05:00
Carolyn Van Slyck
d0e80377d5 Fix typo (#504) 2018-08-17 09:36:10 -07:00
Pontus Leitzler
f77da764b5 Clarify lookupOnRegistry response.. (#490)
.. so it matches the algorithm
2018-08-16 14:44:19 -07:00
Jeremy Rickard
6060fe033b Update the doc site index to include try it out langauge (#493)
This PR adds basic steps for trying out Athens using the happy-path repo and in memory storage

Co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
2018-08-16 13:41:00 -07:00
Michal Pristas
d088208941 Updated to go1.11rc1 (#482)
* updated to rc1

* latest test
2018-08-15 12:26:43 -04:00
Carolyn Van Slyck
9e4e64b00b Convert Aaron's reddit post into a FAQ (#478)
* Convert Aaron's reddit post into a FAQ

See https://www.reddit.com/r/golang/comments/9704se/the_missing_package_registry_for_golang/?utm_source=share&utm_medium=mweb&_branch_match_id=557725032397199929 for the source material

* Fix links in shortcuts menu

It was hard coded to use full urls, which breaks the netlify previews
2018-08-14 08:35:31 +02:00
Carolyn Van Slyck
e0a983ed38 Link to docs (#440)
* Add link to our new docs site at the top of the readme

* Update links to use docs site, not raw markdown
2018-08-10 08:42:55 +02:00
Michal Pristas
1e6020678e fixed (#435) 2018-08-09 06:54:43 -07:00
Aaron Schlesinger
0551917c03 Adding attribution for athens banner (#432) 2018-08-09 08:05:51 +02:00
Michal Pristas
93ec187568 Docs First of many: Communication flow (#424)
* communication baseline

* doc doc, who's there? new Doc. Yaay

* docs refactor

* small typo

* grammar check

* contributions
2018-08-08 22:58:24 +02:00
Aaron Schlesinger
0a26b39010 Adding Athens banner (#409) 2018-08-06 13:21:00 -07:00
Brian Ketelsen
8ef9d7f1fe documentation modifications, logo (#341) 2018-07-27 12:39:28 -04:00
Brian Ketelsen
1dfbf799c3 adding logo thanks @ashleymcnamara 2018-07-26 17:58:25 -04:00
Brian Ketelsen
c95daa79c1 docs: hugo site generator for docs endpoint (#18)
* docs: add docs endpoint with pretty template. partially fixes #17

* add docs target to makefile, modify hugo target
2018-03-01 11:20:53 -08:00