Docker Documentation Builds #133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Spartee
added
area: docs
al-rigazzi
reviewed
Jan 27, 2022
There was a problem hiding this comment.
This PR looks very good and it is a great step towards a better process.
I have just found a couple of typos, noticed a couple of things that might be improved, and left a comment about CMake installation in containers. Maybe let's just decide on what we are going to do for the latter and then it can be merged.
This new GH action should consistently update the documentation with the latest code on develop.
tutorials dockerfile added to the composition. Currently uses develop, but a prod dockerfile will eventually be added as well
Spartee
force-pushed
the
docker-tutorials
branch
from
f79392e
to
72d34d6
Compare
Spartee
requested review from
al-rigazzi
and removed request for
al-rigazzi,
EricGustin and
MattToast
al-rigazzi
approved these changes
Jan 28, 2022
EricGustin
added a commit
to EricGustin/SmartSim
that referenced
this pull request
Jan 28, 2022
EricGustin
added a commit
to EricGustin/SmartSim
that referenced
this pull request
Jan 28, 2022
al-rigazzi
pushed a commit
to al-rigazzi/SmartSim
that referenced
this pull request
Jan 31, 2022
This PR adds the ability to build the documentation inside a docker build so that users don't have to worry about the specific build steps. The build exports the docs folder into the current clone so that the dev doesn't have to do it themselves. build with ``make docks``. The manual documentation build is still available with make docs. There is also a new make tutorials that builds the tutorials into a developer docker with the current clone of SmartSim. This will eventually have a prod docker build too whch downloads the pinned version of smartsim for the latest release. [ committed by @Spartee ] [ reviewed by @al-rigazzi ]
al-rigazzi
pushed a commit
to al-rigazzi/SmartSim
that referenced
this pull request
Jan 31, 2022
This PR adds the ability to build the documentation inside a docker build so that users don't have to worry about the specific build steps. The build exports the docs folder into the current clone so that the dev doesn't have to do it themselves. build with ``make docks``. The manual documentation build is still available with make docs. There is also a new make tutorials that builds the tutorials into a developer docker with the current clone of SmartSim. This will eventually have a prod docker build too whch downloads the pinned version of smartsim for the latest release. [ committed by @Spartee ] [ reviewed by @al-rigazzi ]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the ability to build the documentation inside a docker build so that users don't have to worry about the specific build steps. The build exports the
docsfolder into the current clone so that the user doesn't have to do it themselves. build withmake docks. The manual documentation build is still available withmake docs.Also added is a way for us to have develop documentation. Each PR that is merged, a new workflow will build the documentation in docker and push it to the doc branch which is hosted on github pages. this will only occur if the PR is reviewed, accepted, and merged.
There is also a new
make tutorialsthat builds the tutorials into a developer docker with the current clone of SmartSim. This will eventually have a prod docker build too whch downloads the pinned version of smartsim for the latest release.minor things