23 Commits

Author SHA1 Message Date
WillAbides
40ef226d3c Replace limit with pagesize in docs for catalog endpoint (#1641)
Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
2020-06-29 09:26:54 -04:00
Zhongpeng Lin
b456c5c189 Escaping underscore (#1516)
Co-authored-by: Rob j Loranger <dev@loranger.xyz>
2020-01-19 16:58:22 -08:00
Aaron Schlesinger
3edd242848 Revamping the download mode file (#1508)
Also doing a few things in the process:

- Deprecating the documentation that references the filter file
- Changing the order of the configuration documentation to put the deprecated documents at the bottom of the config section
- Adding a note to the disk storage documentation about pre-filling the disk cache

Fixes https://github.com/gomods/athens/issues/1501
2020-01-13 13:28:59 -08:00
Ewan Valentine
ea537e7d0d FIXED type-o in docs (#1254) 2019-05-29 17:36:12 -04:00
Ramana Venkata
3e853dbb01 Fix Typo (#1067) 2019-02-16 21:20:18 +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
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
Manu Gupta
0b3dc6e8ef Don't use the terms caching in our docs (#865)
* removes caching from docs

* Remove cache from the docs and replace it with storage

* separate out fetch part
2018-11-05 15:09:59 -08:00
Michal Pristas
3a190df2db replace the proxy with its name (#823) 2018-10-26 11:48:35 -07:00
Aaron Schlesinger
dbac943f3e removing registry page (#802)
* removing registry page

* removing registry page

* removing more references to the registry and 'foundation'

* remove readme references to registry, etc...

* remove registry stuff from development docs

* removing registry from README
2018-10-25 15:39:38 -07:00
Michal Pristas
1dc33bd150 Docs from vcs to user (#747)
* new docs

* new docs

* order

* fixed link

* comments
2018-10-22 14:08:12 -07:00
Michal Pristas
8ed0099514 Updated communication docs (#745)
* updated docs

* updated pics

* Update communication.md

s/cache/storage

* Update communication.md

more comments addressed
2018-10-18 12:34:47 -07:00
Gil
aeb39bf51c add new configuration and authentication section https://github.com/g… (#786)
* add new configuration and authentication section https://github.com/gomods/athens/issues/769

* update weight on all index pages, add new line to authentication.md and update description on configuration index page

* add new line and 'front matter' to add as a page

* add new line to end of file
2018-10-18 12:16:24 -07:00
Federico Paolinelli
13a2e1b5e9 Moved .netrc instructions as Install subpage (#771)
* Moved .netrc instructions as Install subpage

* Added missing file
2018-10-15 20:29:33 -04:00
Aaron Schlesinger
48e73f772d Adding section headers to the docs (#742)
* Adding a section page for installing

* adjusting section ordering

so that the section list reads more like a story front to back

* Adjusting intro title

* removing redundant title

* Adding a body to the design section header

* Adding more to the contributing front page

* Splitting up sections in the install front page

* adding intro summary

* Better description of federation

* adding new maintainer language

* relative link

* more grammar and formatting fixes
2018-10-09 09:16:45 -05:00
Tomasz Tomalak
dfe939e14c Proxy: Add HGRC file mount (#720)
* Proxy: Add HGRC file mount

* Rename and move dotFile initializer, lower permission for authFiles
2018-10-03 20:13:57 +02:00
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
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
Pontus Leitzler
f77da764b5 Clarify lookupOnRegistry response.. (#490)
.. so it matches the algorithm
2018-08-16 14:44:19 -07: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
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