Commit Graph

33 Commits

Author SHA1 Message Date
Aaron Schlesinger
c2c5daf61a Switching to using the main default branch (#1628)
* Switching to using the main default branch

* changing links to main branch, not master branch

* Changing a few links to relative

* Bumping chart version

Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
2020-06-15 16:44:37 -04:00
Ted Wexler
524b93d2c8 Update the release steps with a few details (#1616)
* Add a step to the helm release procedure to update the docker image version

* Clarify the link for creating release notes
2020-05-19 10:54:18 -07:00
Aaron Schlesinger
22dfffe968 Updating the release notes (#1603) 2020-05-19 13:14:52 -04:00
Aaron Schlesinger
130963486b Adding notes for how to do a release (#1576)
* Adding notes for how to do a release

* Changes

thanks @marwan-at-work and @twexler

* bumping to get netlify to run (again)

Co-authored-by: Ted Wexler <ted@stuckinacan.com>
2020-03-20 16:41:51 -04:00
Rick Beton
f8bdeb52f6 SystemD installation (#1445)
* First implementation; older systemd is not yet supported; SysV is not supported at all

* small correction

* more documentation; manual testing confirms that Athens is working as a SystemD service

* documentation updates

* removed differences from author/master branch
2019-12-05 16:53:40 -08:00
Nick Miyake
65287a3df4 Remove extraneous period in DEVELOPMENT.md (#1425) 2019-10-17 20:03:23 -07:00
Brian Falk
df82bbc0f3 Add support for Sail development environments (#1248)
* initial sail Dockerfile

* host mount the module download cache so it's preserved over restarts

* expose port 3000

* add some basic docs
2019-08-05 13:26:16 -07:00
Sterling Deng
b2b9c378f6 fixed typos (#1262) 2019-05-31 08:21:17 -04:00
Ryuzo Yamamoto
7598e7030a Add "git clone" to command for checking out the code in DEVELOPMENT.md (#1258) 2019-05-29 22:48:31 -04:00
Aaron Schlesinger
f969033075 Adding a way to run an Athens in docker (#1082)
* Adding a way to run an Athens in docker

* adding phonies 😄

* fixing docs

to point to the right Makefile target

* s/post/port

* Making docs a little more clear

And better formatted
2019-05-02 21:28:54 +02:00
Aaron Schlesinger
c2647da423 Adding ability to run all tests inside docker containers (#973)
* Adding ability to run all tests inside docker containers

* Adding test dockerfile

* Small changes to the testing sections
2019-02-15 19:16:02 +01:00
Pascal Dierich
9964e84902 fixes typos (#1031)
* fix typo in DEVELOPMENT.md

* fix doc typo in upstream_lister.go

* Remove Olympus references

* fix typo in DEVELOPMENT.md

* Update DEVELOPMENT.md
2019-01-05 13:21:24 -05:00
Marwan Sulaiman
969ea0790a docs: update development guides (#1017)
* docs: update development guides

* pr fixes
2018-12-26 16:26:59 -08:00
Henry Jenkins
005b36d50b Improve docs for developing docs (#937)
* Improve docs for developing docs

+ Mention `make docs` definition
+ Fix docker run command
~ Change docker command to run it from project root

* Further improve the development docs

* Fix grammar in development docs
2018-11-22 17:58:48 -05:00
Marwan Sulaiman
9f8e7bc145 Update docs for those struggling to set up buffalo (#871)
* Update docs for those struggling to set up buffalo

* mention golint

* pr fix
2018-11-06 20:55:10 -05:00
Chris Mills
50876fbf79 Add Dockerfile for docs (#857)
There's no official image for hugo, so lets make our own and have the
Makefile build the Dockerfile

Add some basic documentation

I've added some simple documentation and tidied up the Dockerfile. I
move the file to use best practice and reduced the size slightly.
Personally I don't think we'll need to alter the address and not watch
files as it's only going to be used for local development atm. It might
be useful in future to move to being able to alter these if we're using
this in production

Don't use docs use hugo

It would be confusing for people to docker pull the docs but not have
any docs included in them. hugo as the name would make way more sense.

Don't lock down to digest

We should trust official libs, especially the alpine build.

Signed-off-by: Chris M <millscj01@gmail.com>
2018-11-02 12:11:11 -04: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
Henry Jenkins
532e93e119 Remove Olympus code (#779)
* Remove nolonger used moniker package

Usage was removed in 97d8013

* Remove reference to Zeus

Use name Proxy for now.

* Remove Olympus code

See github issue #777

* Remove Olympus related vendor modules

* Mention Olympus removal in docs

* Add note about no registries existing

* Remove eventlog

* Update docs for Olympus removal
2018-10-22 11:52:02 -07:00
Adina Budriga
b1502bac70 Update the DEVELOPMENT.md file. Add a warning that docker-compose -p athensdev up -d mongo (#708)
Makefile:55: recipe for target 'alldeps' failed does not start Athens or Olympus.
2018-10-03 10:54:34 -05:00
Komu Wairagu
748ed7dda9 Remove dep files (#378)
* remove vendor directory
athens will be using Go modules for dependency management

* remove Gopkg.* files. athens will be using Go modules for dependency management

* add note about Go version required for developing on Athens
To use Go modules for dep management, you require atleast Go version 1.11

* update documentation regarding supported version of Go

* dont install dep

* re-add vendor directory
go mod vendor

* use vendored directory to carry out Go commands

* remove the use of -mod=vendor
this is necessary because;
1. we are running ci in a travis with a matrix of GO111MODULE=on & GO111MODULE=auto
and -mod=vendor is not available as an option in GO111MODULE=auto(inside GOPATH)

* rm vendor

* run go mod tidy
this is beacuse the master branch had changes to Gopkg.lock

* match gopkg.in/go-playground/validator.v9 version
with master branhc

* go mod tidy

* go mod vendor
so as to vendor the new changes that were added in master

* set GO111MODULE=on globally in ci

* build with -mod=vendor when building docker image

* use -mod=vendor to avoid getting deps from vcs in ci

* use -mod=vendor in .drone.yml

* use go1.11 in drone.yml
2018-09-02 11:54:42 -04:00
Arthur Mello
0b9624afbf Update documentation about running unit tests (#576) 2018-08-28 18:27:50 +02: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
Aaron Schlesinger
87f65bac7a adding document that explains how reviews happen on PRs (#470)
* WIP: adding document that explains how reviews happen on PRs

Fixes https://github.com/gomods/athens/issues/467

* adding more steps

* Incorporate review feedback

co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
co-authored-by: Aaron Schlesinger <arschles@gmail.com>

* Fix verify your work to specify what the CI runs

co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
co-authored-by: Aaron Schlesinger <arschles@gmail.com>

* Keep important PRs open longer

co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
co-authored-by: Aaron Schlesinger <arschles@gmail.com>
2018-08-24 15:34:49 -07:00
Michal Pristas
44ec04dd4d updated to rc2 (#557) 2018-08-23 08:09:10 +02:00
Michal Pristas
d088208941 Updated to go1.11rc1 (#482)
* updated to rc1

* latest test
2018-08-15 12:26:43 -04:00
Andrey Dyachkov
051f3884e1 Bring more clarity on how to run unit tests (#449)
* The commit brings more clarity on how to run unut tests.

The commit chages behaivour of `make test-unit` by adding sourcing of
env vars. Documentation is updated to provide more clarity on how to run
unit tests.

* changed list of commands to run before unit tests

* moved env vars to .env

* removed dduplicated env var

* returned conventional file name in script

* link to DEVELOPMENT.md

* fixed typo

* moved env var export to script

* removed export of tmp folder
2018-08-11 12:12:24 -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
Manu Gupta
80dba0d83b Update docs to show how to update go version irrespective of vendor (#418) 2018-08-08 11:13:19 -07:00
Rohan Chakravarthy
8bb5a40065 fix links in dev.md (#411) 2018-08-04 16:24:58 -07:00
Marwan Sulaiman
22c1d86411 Makefile: minimum dependencies for dev environment (#375)
* Makefile: minimum dependencies for dev environment

* docs

* Makefile: merge alldeps and dev project names

* restart build
2018-08-01 03:17:27 -04:00
Carolyn Van Slyck
21cd7239db Make it easier to run all the same commands that Travis does (#362)
* Make it easier to run all the same commands that Travis does

* Add target to install dev tools

* Dirty a temp directory instead of the repo root

* Explain our new make targets

* Set a TMPDIR on travis

* Fix comment
2018-07-30 13:27:40 -07:00
Emil Stolarsky
f138bbb0ca Specify buffalo v0.12.4 or higher is required (#323) 2018-07-27 13:17:14 -07:00
Aaron Schlesinger
a4e39c82d8 Refactoring readme and adding a DEVELOPMENT doc (#233) 2018-07-09 15:19:44 -07:00