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.

Sign up for GitHub

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

Jump to bottom

Move drmemory.org to Github Pages, with automatic doxygen docs deployment from Travis #2260

Open
derekbruening opened this issue Feb 16, 2020 · 1 comment
Open

Move drmemory.org to Github Pages, with automatic doxygen docs deployment from Travis #2260

derekbruening opened this issue Feb 16, 2020 · 1 comment
Assignees
@derekbruening
Labels
Component-Docs Maintainability

Comments

@derekbruening
Copy link
Contributor

This is the Dr. Memory equivalent of DynamoRIO/dynamorio#2860 and DynamoRIO/dynamorio#3194.
@derekbruening derekbruening self-assigned this Feb 16, 2020
derekbruening added a commit that referenced this issue Feb 17, 2020
@derekbruening
i#2260: Auto-deploy docs to Github Pages
6a271a3 
Adds a copy_docs parameter to package.cmake, which copies the html/
docs dir to the top level for access by Travis.  Adds a DEPLOY_DOCS
env var which directs Travis and runsuite_wrapper.pl to enable this.

Adds uploading of the html/ directory to the drmemory_docs Github
Pages repository via the Travis "pages" provider.

Issue: #2260
@derekbruening derekbruening mentioned this issue Feb 17, 2020
Merged
derekbruening added a commit that referenced this issue Feb 17, 2020
@derekbruening
i#2260: Auto-deploy docs to Github Pages (#2261)
b40f48e 
Adds a copy_docs parameter to package.cmake, which copies the html/
docs dir to the top level for access by Travis.  Adds a DEPLOY_DOCS
env var which directs Travis and runsuite_wrapper.pl to enable this.

Adds uploading of the html/ directory to the drmemory_docs Github
Pages repository via the Travis "pages" provider.

Reinstates the header and footer pages incorrectly removed by 42b0a02 to
satisfy warnings in newer doxygens.  Instead we create empty files up front.

Issue: #2260
derekbruening added a commit that referenced this issue Feb 18, 2020
@derekbruening
i#2260 doc-deploy: Fix error in Travis config
896e37f 
Fixes an incorrect env var name for triggering our docs deployment.

Issue: #2260
@derekbruening derekbruening mentioned this issue Feb 18, 2020
Merged
derekbruening added a commit that referenced this issue Feb 18, 2020
@derekbruening
i#2260 doc-deploy: Fix error in Travis config (#2262)
019037d 
Fixes an incorrect env var name for triggering our docs deployment.

Issue: #2260
derekbruening added a commit that referenced this issue Feb 18, 2020
@derekbruening
i#2260 doc-deploy: Use per-repo access token
21439b4 
Replaces the token with one targeting the drmemory repo, as apparently
the encryption is per-repository.

Issue: #2260
@derekbruening
Copy link
Contributor Author

Success, after several tries:
https://travis-ci.com/DynamoRIO/drmemory/jobs/288271807

    Deploy DynamoRIO/drmemory_docs to github.com/DynamoRIO/drmemory_docs.git:master

And https://dynamorio.org/drmemory_docs/ says "2.3.18309"

derekbruening added a commit that referenced this issue Mar 28, 2021
@derekbruening
i#2260 web: Produce doyxgen suitable for web embedding
04ffb47 
Copies DynamoRIO's method of producing doxygen suitable for
embedding in Github Pages jekyll.
Since we need custom menu tweaking, we now use our own
copy of CMake_rundoxygen rather than sharing DR's as-is.

Issue: #2260
@derekbruening derekbruening mentioned this issue Mar 28, 2021
Merged
derekbruening added a commit that referenced this issue Mar 29, 2021
@derekbruening
i#2260 web: Produce doyxgen suitable for web embedding (#2397)
7c5b7b4 
Copies DynamoRIO's method of producing doxygen suitable for
embedding in Github Pages jekyll.
Since we need custom menu tweaking, we now use our own
copy of CMake_rundoxygen rather than sharing DR's as-is.

Issue: #2260
derekbruening added a commit that referenced this issue Mar 29, 2021
@derekbruening
i#2260: Add web content to doxygen for integrated site
19e8030 
Adds the home page and Chinese quickstart page to the new integrated
site. The Chinese page is replaced by actual content in
drmemory.github.io as I had trouble getting the current raw html
through doxygen.

Updates the logo on the README while updating images.

Issue: #2260, #2308
Fixes #2308
@derekbruening derekbruening mentioned this issue Mar 29, 2021
Merged
derekbruening added a commit that referenced this issue Mar 29, 2021
@derekbruening
i#2260: Add web content to doxygen for integrated site (#2398)
6fd2316 
Adds the home page and Chinese quickstart page to the new integrated
site. The Chinese page is replaced by actual content in
drmemory.github.io as I had trouble getting the current raw html
through doxygen.

Updates the logo on the README while updating images.

Issue: #2260, #2308
Fixes #2308
derekbruening added a commit that referenced this issue Jun 27, 2021
@derekbruening
i#2260 web: Add automated web content generation
3664de0 
Adds a Github Action script to generate the drmemory.org
web content.  This can't be tested on a branch, so this
will have to be merged and any fixes or fine-tuning done
separately.

Issue: #2260
@derekbruening derekbruening mentioned this issue Jun 27, 2021
Merged
derekbruening added a commit that referenced this issue Jun 27, 2021
@derekbruening
i#2260 web: Add automated web content generation (#2407)
ddda8a1 
Adds a Github Action script to generate the drmemory.org
web content.  This can't be tested on a branch, so this
will have to be merged and any fixes or fine-tuning done
separately.

Issue: #2260
derekbruening added a commit that referenced this issue Jun 27, 2021
@derekbruening
i#2260 web: Finalize new automated web generation
0aab217 
Fixes issues with the initial commit of the Action to generate
the new web content:
- Wrong path to runsuite_wrapper.pl

Removes the old drmemory_docs generation step from the ci-package
action.

Issue: #2260
@derekbruening derekbruening mentioned this issue Jun 27, 2021
Merged
derekbruening added a commit that referenced this issue Jun 27, 2021
@derekbruening
i#2260 web: Finalize new automated web generation (#2408)
0b9f5e7 
Fixes issues with the initial commit of the Action to generate
the new web content:
- Wrong path to runsuite_wrapper.pl
- Add missing submodules
- Add package.cmake copy of embedded docs
- Add error checking for an empty glob
- Fix install path for embedded docs

Removes the old drmemory_docs generation step from the ci-package
action.

Issue: #2260
derekbruening added a commit that referenced this issue Jun 28, 2021
@derekbruening
i#2260 web: Add wiki content to doxygen docs
b9bef7c 
Adds all of the Github wiki content to new doxygen docs pages
integrated into the web site.

Updates references to wiki pages in other files in the repository.

Issue: #2260
@derekbruening derekbruening mentioned this issue Jun 28, 2021
Merged
derekbruening added a commit that referenced this issue Jun 28, 2021
@derekbruening
i#2260 web: Add wiki content to doxygen docs (#2409)
c7a9f29 
Adds all of the Github wiki content to new doxygen docs pages
integrated into the web site.

Updates references to wiki pages in other files in the repository.

Issue: #2260
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@derekbruening derekbruening

Labels
Component-Docs Maintainability
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@derekbruening