Commit Graph

120 Commits

Author SHA1 Message Date
Marwan Sulaiman
0cac0edbf1 actions: support proxying sum db urls (#1208)
* actions: support proxying sum db urls

* remove proxy prefix

* add docs for checksum db

* more docs

* typo

* typo

* typo

* typo

* typo

* typo

* typo

* typo

* move checksum db into its own section
2019-05-08 17:09:07 -07:00
Scott Lee
fd1cd2e0b1 Refer to a consistent minimum Go version (#1201)
* Refer to a consistent minimum Go version

* Refer to a consistent minimum Go version

* Change Go version to v1.12
2019-05-02 12:47:54 -07:00
Scott Lee
a327db006a Clear up language and remove duplicate content (#1202) 2019-04-30 12:14:45 -07:00
dfinkel
0be1cd96f0 Add documentation about SSH_AUTH_SOCK from PR#1184 (#1185)
* Add documentation about SSH_AUTH_SOCK from PR#1184

PR#1184 added support for propagating SSH_AUTH_SOCK if it points to a
valid unix socket. As requested, add a section explaining how to use
it.

* auth documentation: replace $(pwd) with $PWD

Replace references to `$(pwd)` with `$PWD` in shell snippets and add
more quoting. This should make these snippets reasonably friendly to
currnet working directory path components containing spaces.

Note: I neither endorse nor recommend spaces in directories, but this is
an easy enough change.

This commit is leaving powershell snippets untouched as I am not
familiar with powershell's word-splitting behavior (if there is any).
2019-04-30 01:03:17 -07:00
Aaron Schlesinger
5dda2bee6c Refactoring the developer meetings page (#1178)
* adding JS files

* updating the dev meetings page

* trying to see if time zones work

this works locally but I have no idea why...

* dealing with APAC times

where it's really Friday

FEEL THE PAIN

* removing dead and commented code
2019-04-22 21:31:38 -07:00
Rimas Mocevicius
f14707e5e5 [chart] add upstream proxy support, bump athens version (#1161)
* [chart] add upstream proxy support, bump athens version

* update chart readme and kubernetes install docs
2019-04-05 13:58:57 -07:00
Aaron Schlesinger
2a2159291f Removing the line number from the config link (#1158)
Fixes https://github.com/gomods/athens/issues/1157
2019-03-29 07:40:15 +01:00
Shivaram Radhkrishna
63a06dbdeb Include path in the proxy command example (#1163)
* fix missing . in command example

* Indicate path in the proxy command example
2019-03-28 21:27:10 -07:00
David
79ef098804 docs: translate intro into spanish (#1134)
translate intro documentation into spanish - introducción en español
2019-03-26 16:42:13 -04:00
Zhao Xiaojie
83b460b5f0 Add translation for intro (#1128)
* Translate intro index

* translate intro first-content

* translate intro protocol

* translate intro components

* Fix expression

* Fix expression

* Fix expression

* Update components.zh.md

* Update protocol.zh.md

* Update components.zh.md
2019-03-26 13:22:13 -04:00
Aaron Schlesinger
b9bdbc3123 3 components instead of 4 (#1147) 2019-03-19 15:45:31 -07:00
Shivaram Radhkrishna
c59aa69848 Doc update to configure upstream proxy to fetch modules from a Go mod… (#1146)
* Doc update to configure upstream proxy to fetch modules from a Go modules repository

* review suggestions
2019-03-19 15:03:44 -07:00
Federico Paolinelli
04c6bbed90 Filter (#1075)
* Working tests

* More tests, a bugfix (yay tests) and docs

* Changed filter description adding v prefix to versions

* Updated docs to be more precise

* More robust, changed docs

* Fixed copy paste bug
2019-03-18 22:07:27 -07:00
Johan Brandhorst
a79a836204 docs: update references to Go 1.11 (#1125)
* docs: update references to Go 1.11

Go 1.12 is out now, which might confuse some readers.

* docs: use version 1.12 or later
2019-03-12 16:02:01 -04:00
tsunami42
05e5d0a5ae fix dead links (#1127) 2019-03-12 12:45:53 -07:00
Zhao Xiaojie
59363b47ac Add translation for Chinese (#1112)
* Add translation for Chinese

* Remove English comments

* Fix the expression
2019-03-12 12:19:44 -07:00
Aaron Schlesinger
7561d5384e Further alterations to the install documentation (#1098)
* Further alterations to the install documentation

This is a follow-up to https://github.com/gomods/athens/pull/1095. I accidentally merged that :( so I am rolling forward here based on comments in the previous PR

* simplifying
2019-03-05 17:54:19 -05:00
Aaron Schlesinger
9c07647488 Updating docs to reference v0.3.0 (#1104) 2019-03-05 14:47:29 +01:00
Aaron Schlesinger
8caad2bc54 Updating helm docs to point to the new helm chart repository (#1102)
* Updating helm docs to point to the new helm chart repository

Fixes https://github.com/gomods/athens/issues/1099
Follow-up to https://github.com/gomods/athens/pull/1097/files

* fixes
2019-03-04 08:24:55 -06:00
Aaron Schlesinger
7bf99e1e6e adding a section on immutability (#1095)
* adding a section on immutability

* changes thanks to Piotr
2019-03-01 14:50:50 -08:00
Aaron Schlesinger
280d9f3f16 Adding a document for installing Athens on ACI (#967)
Fixes https://github.com/gomods/athens/issues/57
2019-02-21 08:59:59 +01:00
Ramana Venkata
3e853dbb01 Fix Typo (#1067) 2019-02-16 21:20:18 +01:00
Mark Petrovic
feff9872cd [issue/1048] Describe how to configure Athens to resolve dependencies… (#1049)
* [issue/1048] Describe how to configure Athens to resolve dependencies over authenticated SSH

Issue: 1048
Files changed:  docs/content/configuration/authentication.md

* [1048] pull request feedback
2019-02-06 20:13:21 -05:00
Chad Kunde
7811524c22 Version filtering (#1050)
* extend filtering logic and configuration to include version lists

Module filtering is very useful, but many deployments will need to
satisfy even more granular constrainsts.  Enterprises may need
approved lists specific down to the minor (or patch) version element.

Version filtering logic is similar to the module filtering, in that
it's a prefix match of the version requested against each entry in the
version filter list.

Closes #1045

* include version filtering in documentation with example

* allow filtering when version is missing

Endpoints that do not specify a version, such as "@v/list", only need
to be filtered by module rules.
2019-02-05 09:04:09 +01:00
Marwan Sulaiman
b17bfb3d0a docs: remove commit hash from known limitations (#1019) 2019-01-15 20:41:29 +01:00
Manu Gupta
23b285d49d Catalog endpoint support for mongo (#985)
* Added new cataloger interface

* Implementing catalog protocol

* Propagated to protocol and over

* First round of fixes

* S3 almost ready, need to be tested

* Going on with testing s3

* Better testing with s3

* Simplified catalog tests

* Preparing gcp tests to access a gcp instance

* Fixing initialization errors

* Removed some prints

* Gcp ready, to be tested

* Gcp working

* Aligned bucket mock to catalog method

* Switched res payload to json

* Added catalog method to all storage instances

* Added catalog method to unsupported storages

* Fixed with pool test

* Restored tests

* Fixed gcp constructor

* Implemented catalog for fs

* Removed trace

* E2e tests, fixed fs

* Fixed module name return value

* Added cataloger method to azure storage

* Added docs

* Changed pagesize parameter name

* Fixed gofmt error

* Added json tags to result. Fixed lint warning

* Removed extra line

* Changed not implemented error to http.KindNotImplemented

* Checking for inequality on results

* Lower-cased json keys

* Added cleaning of path separator

* Fixed review comments

* Add catalog endpoint for mongo

* Add omitempty to ID

* Fix catalog tests

* update for next token

* fix e2e

* Make query readable

* Fix language and e2e script

* remove new line
2019-01-02 22:13:56 -08:00
Quinn Slack
312f1d56a9 fix typo (Kuberentes -> Kubernetes) (#1021) 2018-12-31 20:27:24 -08:00
M4RK
a7aaf3f1e4 Modified S3 storage to check for AWS default credentials. (#1009)
* Modified S3 storage to check for AWS default credentials.

* Updated S3 storage documentation.

* Fixed typo.
2018-12-29 22:11:50 -08:00
Marwan Sulaiman
969ea0790a docs: update development guides (#1017)
* docs: update development guides

* pr fixes
2018-12-26 16:26:59 -08:00
Roger Guldbrandsen
4c2c3a24b0 Add missing link to storage configuration docs (#1006) 2018-12-20 16:27:36 +01:00
marpio
aee30a4209 make target and docs (#1002)
* make target and docs

* fix grammar
2018-12-18 05:56:31 -08:00
Federico Paolinelli
0258e17d89 Catalogendpoint (#955)
* Added new cataloger interface

* Implementing catalog protocol

* Propagated to protocol and over

* First round of fixes

* S3 almost ready, need to be tested

* Going on with testing s3

* Better testing with s3

* Simplified catalog tests

* Preparing gcp tests to access a gcp instance

* Fixing initialization errors

* Removed some prints

* Gcp ready, to be tested

* Gcp working

* Aligned bucket mock to catalog method

* Switched res payload to json

* Added catalog method to all storage instances

* Added catalog method to unsupported storages

* Fixed with pool test

* Restored tests

* Fixed gcp constructor

* Implemented catalog for fs

* Removed trace

* E2e tests, fixed fs

* Fixed module name return value

* Added cataloger method to azure storage

* Added docs

* Changed pagesize parameter name

* Fixed gofmt error

* Added json tags to result. Fixed lint warning

* Removed extra line

* Changed not implemented error to http.KindNotImplemented

* Checking for inequality on results

* Lower-cased json keys

* Added cleaning of path separator

* Fixed review comments

* Fixed docs
2018-12-12 21:17:26 +01:00
Aaron Schlesinger
2375237795 fixing typo in protocol docs (#988) 2018-12-10 09:13:37 +01:00
Y.Horie
8a5322859f Fix typo in protocol.md #978 (#987) 2018-12-09 20:33:09 -08:00
Chris Mills
c00480ef81 Correct reference to public proxy. (#964)
We should reference the new public proxy address that's probably going
to end up becoming the URL for the public version. Unless we change it
to proxy.gomods.io or similar.

Signed-off-by: Chris M <me@christophermills.co.uk>

Move to experimental

It's experimental not public.

Signed-off-by: Chris Mills <me@christophermills.co.uk>
2018-12-07 14:59:25 -08:00
Manu Gupta
db57c1e764 Make the docs clearer for minio-comaptible storages (#953)
* Make the docs clearer

* fix typo

* Update language for the docs

* Update docs
2018-12-02 22:25:24 +01:00
Tomasz Tomalak
edc2f7842c Add check if GCP bucket exists and remove GCP Bucket create (#952)
* Add check if GCP bucket exists, Remove bucket creation

* Update GCP section in Storage Configuration docs

* Add more explicit info if bucket not exists
2018-12-01 17:53:15 +01:00
Aaron Schlesinger
62e1838ef4 changing the zoom link to a shortlink (#956) 2018-11-30 08:34:08 -05:00
Tomasz Tomalak
bd2ebddc9b Remove timeouts from Storage documentation (#951) 2018-11-28 10:43:46 -05:00
Henry Jenkins
e70ecf9beb Alibaba OSS Storage (#948)
* Remove trailing whitespace

* Add docs about Alibaba OSS support

* Fix missed changes in docs
2018-11-28 09:45:28 -05:00
marpio
987291ae00 update walkthrough docs (#945) 2018-11-26 18:47:51 -08:00
Alessandro De Blasis
35231b7365 Fixed more typos (#940) 2018-11-21 10:10:48 -05:00
Alessandro De Blasis
3538767f8d Fix typo (#939) 2018-11-21 09:34:40 -05:00
Henry Jenkins
3d4450513e Adds Github ribbon link to docs (#936)
Based off of https://blog.github.com/2008-12-19-github-ribbons/
2018-11-21 06:05:57 -05:00
Tomasz Tomalak
88725b7778 Add docs about storages in athens (#883)
* Add docs about storages in athens
Fix wrong description in config.dev.tom

* Storage docs tweaks

* Change Disk storage description

* Fix spelling/grammar issue in storage.md

* Remove chapter value from configuration/_index.md

* Rename Config to Configuration
2018-11-20 15:11:51 -05:00
Nuno do Carmo
2b6bf6ca9a Changed HUGO_VERSION variable to ARG instead of ENV (#901)
this is a small change, however it will allow the creation of images based on a specific GoHugo version if needed.
The build command should be something like:
`docker build --build-arg HUGO_VERSION=0.51 -t repo/image-name .`

I tested the build as written above and it worked fine, but please feel free to test it further.
2018-11-16 09:59:06 -05:00
Chris Mills
3718749f47 Move PHILOSOPHY.md to our docs site (#877)
As per the ticket, we'll move the PHILOSOPHY document to the docs. I
also spotted a spelling mistake which got fixed when I replaced the
text in the first page of contributing.

Signed-off-by: Chris M <millscj01@gmail.com>
2018-11-16 09:30:34 -05:00
Carolyn Van Slyck
f39b013629 Document our docker tags (#911)
* Document our docker tags

* Fix links on install page
2018-11-12 14:22:34 -08:00
Carolyn Van Slyck
bee463053a Rename docker image (#909)
* Rename docker image to gomods/athens

* Bump chart version to match new release version

* Switch from stable tag to latest tag

Our docs used latest, and it's awkard when you don't have a latest tag anyway
2018-11-12 15:15:58 -06:00
Chris Mills
a44291793d Add more prominent area to advertise our meetings (#881)
Taking some design tips from the Harbor project, lets use something
similar on Athens.

===

Alter text slightly to read better

I feel that this text reads slightly better than before

===

Don't use the participating section...

Due to a mistake, I used the participating page rather than the
developer meeting page

Signed-off-by: Chris M <millscj01@gmail.com>
2018-11-09 14:03:07 -08:00