You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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 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 withindev.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.The text was updated successfully, but these errors were encountered: