diff --git a/docs/source/currentprogress.md b/docs/source/currentprogress.md new file mode 100644 index 00000000..4a793dac --- /dev/null +++ b/docs/source/currentprogress.md @@ -0,0 +1,28 @@ +# Current Progress + +## UI + +[Viewable Here](http://nginx.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone/) + +The UI is a set of components that have been built using react, they are viewable +using the link above, which is a running version of react-storybook. + +## Frontend + +[Viewable Here](http://frontend.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone:8000/) + +## Docs + +[Viewable Here](http://docs.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone/) + +## CloudAPI Graphql + +[Accessible Here](http://cloudapi.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone:3000/) + +## Spikes + +The spikes within this project is small pieces of work, implementing features that +we are either not too sure about or wish to find more information on. + +Spikes are not currently hosted anywhere, however they are accessible from github +within the main repository. diff --git a/docs/source/deployment.md b/docs/source/deployment.md index 5ce18498..a3f5ed87 100644 --- a/docs/source/deployment.md +++ b/docs/source/deployment.md @@ -39,10 +39,20 @@ _DOCKER_REGISTRY _DOCKER_TLS_VERIFY ``` +## Docker Images + +Each of the service contained within the Joyent Portal repository is deployed +using docker, the are built and tested in CI and when passing are pushed to +[Quay.io](https://quay.io/repository/) under the yldio organisation. + +Images are usually built from our own base image [alpine-node-containerpilot](https://github.com/yldio/alpine-node-containerpilot) +For prosperity, the alpine-node-containerpilot is tagged in quay.io as `latest` +always points at `master`. These tags should represent the version of node being +ran `:6.4.4` and should have a postfix for any no-node changes to the image +`:6.4.4-2`. + ## /.bin/deploy This command is ran at the point when all of the tests are passing. It fires off a call to `docker-compose -d up`. This can equally be ran on a developers machine if manual intervention is needed. - - diff --git a/docs/source/index.rst b/docs/source/index.rst index 60169779..1da57b72 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,8 +10,5 @@ Welcome to Prototype Joyent Portal's documentation! :maxdepth: 2 :caption: Contents: + currentprogress deployment - - -Indices and tables -==================