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

Automatically build and deploy documentation #23

Merged
merged 15 commits into from
Jan 17, 2020
Merged

Automatically build and deploy documentation #23

merged 15 commits into from
Jan 17, 2020

Conversation

mtazzari
Copy link
Collaborator

@mtazzari mtazzari commented Jan 17, 2020

Following this tutorial:
https://circleci.com/blog/automate-your-nuxt-js-app-deployment/

Note: CircleCI only accepts SSH private keys in PEM format, but it is not well documented.
This is useful: https://discuss.circleci.com/t/adding-ssh-keys-fails/7747/24
So, the solution is to use:

 ssh-keygen -m PEM -t rsa -b 4096 -C "ci-build@ast.cam.ac.uk"

instead of

 ssh-keygen -t rsa -b 4096 -C "ci-build@ast.cam.ac.uk"

which is suggested in the tutorial.

@mtazzari
Copy link
Collaborator Author

Documentation:

  • is built automatically for each push to any branch;
  • is deployed to gh-pages for each push to master.

This PR Fixes #4

I merge to master so that the first draft of the documentation is deployed to gh-pages and we check the rendering.

@mtazzari mtazzari changed the title (wip) Automatic generation of documentation - DO NOT MERGE Automatically build and deploy documentation Jan 17, 2020
@mtazzari mtazzari merged commit 36a43bb into master Jan 17, 2020
@mtazzari mtazzari deleted the docgen branch January 17, 2020 14:46
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

Successfully merging this pull request may close these issues.

None yet

1 participant