[CXX-1000] Migrate documentation to GitHub Pages Created: 19/Aug/16 Updated: 19/Oct/16 Resolved: 28/Sep/16 |
|
| Status: | Closed |
| Project: | C++ Driver |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | 3.0.3 |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | David Golden | Assignee: | David Golden |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||
| Description |
|
Our plan is to migrate all documentation to GitHub pages. This includes:
The Driver Playbook has an open code review from the docs team and needs to be migrated into a "docs" directory in the master repo. We then need automation to build and deploy updated docs on demand. We should have the capability to build and deploy documentation for legacy branches and point release branches/tags. |
| Comments |
| Comment by Githook User [ 29/Sep/16 ] |
|
Author: {u'username': u'xdg', u'name': u'David Golden', u'email': u'xdg@xdg.me'}Message: This commit creates a docs/ directory containing a general set It also provides CMake targets to generate and deploy both this static The doxygen configurations are generated dynamically to ensure that The site deployment targets do not create symlinks, which are necessary for
For symlinks to work, there must be a `.nojekyll` file at the top of |
| Comment by David Golden [ 28/Sep/16 ] |
|
Wiki and README pages updated. The wiki pages point to the top of the manual rather than subpages, so that we don't wind up with broken wiki links if we choose to reorganize the manual layout later. |
| Comment by David Golden [ 28/Sep/16 ] |
|
Oops. Shouldn't resolve this until README and wiki pages point to new docs. |
| Comment by Githook User [ 28/Sep/16 ] |
|
Author: {u'username': u'xdg', u'name': u'David Golden', u'email': u'xdg@xdg.me'}Message: This commit creates a docs/ directory containing a general set It also provides CMake targets to generate and deploy both this static The doxygen configurations are generated dynamically to ensure that The site deployment targets do not create symlinks, which are necessary for
For symlinks to work, there must be a `.nojekyll` file at the top of |
| Comment by David Golden [ 21/Sep/16 ] |
| Comment by David Golden [ 31/Aug/16 ] |
|
Potentially useful references:
|