Updates for migrating documentation/website hosting - #98
Merged
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
For a couple of months now the documentation website hosting solution based on GitHub was giving trouble with 404 errors showing up on some pages even thought they were clearly available in the host repository. I believe this had something to do with the content distribution network (CDN) GitHub employs for GitHub pages. It seemed to not play as nicely with sites generated from a newer version of Doxygen.
New Hosting and Updated Domain
To fix this, the documentation website has been moved over to a traditional web server. There is also a new domain: https://www.mast-multiphysics.com. This pull request updates the Travis-CI procedures to deploy automatically to the new host for
masterbranch builds originating from the MASTMultiphysics/mast-multiphysics repository.Temporary Documentation Archives for All Builds
One improvement is also that I've configured the CI process to archive a version of the generated documentation website at https://temp-docs.mast-multiphysics.com for ALL branches on the MASTMultiphysics/mast-multiphysics repository (not done for GitHub forks). This is useful to check that the website builds successfully and looks correct before it deploys on a merge into the
masterbranch in the even you can't run Doxygen locally. The archive can be identified by its corresponding Travis-CI build number.Note that this archival is not done for Pull Request builds to prevent a third-party from getting arbitrary files/code uploaded to the web host by opening a pull request into a MASTMultiphysics/mast-multiphysics branch from an outside fork. For Pull Requests from branches inside the MASTmultiphysics/mast-multiphysics to the main repo master (or another branch) the build corresponding to the original branch will deploy an archive. This is acceptable because we have some control over who can push new branches into the main MASTmultiphysics/mast-multiphysics repository.
As of now, the host will automatically delete archives that are older than 24 hours.