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

Automated build and deployment of demo documentation #402

Closed
vinniefalco opened this issue Jul 11, 2023 · 2 comments · Fixed by #412
Closed

Automated build and deployment of demo documentation #402

vinniefalco opened this issue Jul 11, 2023 · 2 comments · Fixed by #412
Assignees

Comments

@vinniefalco
Copy link
Member

vinniefalco commented Jul 11, 2023

To showcase this product to stakeholders, we need GitHub actions to build and publish reference documentation in a variety of formats for select code bases (I am using Boost.URL as an example but it could be any library that is javadoc-rich). We envision these published URLs:

https://mrdox.com/master/demo/boost-url/adoc-single
https://mrdox.com/master/demo/boost-url/adoc
https://mrdox.com/master/demo/boost-url/xml
https://mrdox.com/master/demo/boost-url/html-single
https://mrdox.com/master/demo/boost-url/html

https://mrdox.com/develop/demo/boost-url/adoc-single
https://mrdox.com/develop/demo/boost-url/adoc
https://mrdox.com/develop/demo/boost-url/xml
https://mrdox.com/develop/demo/boost-url/html-single
https://mrdox.com/develop/demo/boost-url/html

"single" is the single-page output format, otherwise it is multipage. New docs should be built every time there is a change to develop or master, and if we could watch the URL repo that would be nice too. Please put the necessary files such as the mrdox.yml in the URL repo.

Start by manually uploading all the "develop" generated reference documentation so we can have a starting point.

@alandefreitas
Copy link
Collaborator

@sdkrystian I can't do that without your help. We'll have to coordinate on this.

@sdarwin
Copy link
Contributor

sdarwin commented Jul 13, 2023

The website https://mrdox.com/ has been set up as an nginx proxy.
Upload or sync files to a directory in s3.
Don't sync the entire bucket, only one directory.

aws s3 cp --region us-west-2 --recursive ___  s3://cppalliance-ci/mrdox.com/

@alandefreitas alandefreitas linked a pull request Jul 17, 2023 that will close this issue
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 17, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 18, 2023
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jul 27, 2023
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 a pull request may close this issue.

4 participants