Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup automatic deployment to dev website #32

Closed
tomschenkjr opened this issue Mar 8, 2018 · 2 comments
Closed

Setup automatic deployment to dev website #32

tomschenkjr opened this issue Mar 8, 2018 · 2 comments
Assignees
Milestone

Comments

@tomschenkjr
Copy link
Contributor

The plan is to post the Lead Safe API docs to the city's Developer website under the "resources" menu.

To do this, we must "deploy" the documentation from GitHub to a sub-directory on an S3 bucket where dev.cityofchicago.org is hosted. The directory must be located within dev.cityofchicago.org/docs/ directory.

We should use Travis CI to run the necessary mkdocs build to compile the inputs to the final website. Travis CI can then "deploy" to the S3 bucket.

See the Open311 docs as an example for this same process.

Note: the gh-pages branch will be deprecated or perhaps just used to test the display of changes to the documentation.

@tomschenkjr
Copy link
Contributor Author

I've prepared the necessary work and is ready on the dev branch. I've switched-on Travis CI for this project, but Travis CI will only kick-off when there is a .travis.yml file on the master branch.

The configuration will build mkDocs and copy the site to http://dev.cityofchicago.org/docs/lead-safe. It's fine if we copy files prior to the official "launch" because it's unlikely to be discovered until we add links from dev.cityofchicago.org to the documentation (see Chicago/dev.cityofchicago.org#50 and Chicago/dev.cityofchicago.org#51)

When we promote this to master, we should check that the aforementioned link is working.

@geneorama
Copy link
Member

Update for status meeting tomorrow; I don't have this done yet, but I'm planning to tackle this next week.

@tomschenkjr tomschenkjr self-assigned this Apr 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants