[JAVA-3134] Fix docs github links Created: 07/Jan/19 Updated: 04/Feb/19 Resolved: 04/Feb/19 |
|
| Status: | Closed |
| Project: | Java Driver |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Ross Lawley | Assignee: | Ian Whalen (Inactive) |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
Ensure that github links in the docs point to the release branches rather than master. Prevents links becoming stale. Two approaches: 1. Regenerate the documentation via hugo. For all versions: 3.1 - 3.9
2. Just change each release docs in the gh-pages:
*NOTE* From: 3.7.x mongo-java-driver/tree/3.7.x/driver becomes: mongo-java-driver/tree/3.7.x/driver-sync Once that is done, the QuickTours (for sync and async) link needs to be fixed in each maintenance branch to point to the correct docs. |
| Comments |
| Comment by Githook User [ 04/Feb/19 ] |
|
Author: {'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}Message: Docs: Remove links in tour example code
|
| Comment by Ross Lawley [ 04/Feb/19 ] |
|
I removed the links in the QuickTours in master because they will always go out of date and be forgotten. I think its enough there is a link from the docs site.
The 3.10 docs will be added as part of the 3.10 release - so I think this ticket can be closed now.
|
| Comment by Githook User [ 04/Feb/19 ] |
|
Author: {'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}Message: Docs: Remove links in tour example code
|
| Comment by Jeffrey Yemin [ 01/Feb/19 ] |
|
3.10.x is what's in master now ian.whalen. Wouldn't it be a JAVA ticket though? Maybe ross.lawley is following this better than I. |
| Comment by Ian Whalen (Inactive) [ 01/Feb/19 ] |
|
jeff.yemin this is now done except that there' no 3.10.x version of the docs to point to. Should we just close this and file a DOCS ticket for that to happen? |
| Comment by Githook User [ 01/Feb/19 ] |
|
Author: {'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}Message: |
| Comment by Githook User [ 01/Feb/19 ] |
|
Author: {'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}Message: |
| Comment by Githook User [ 01/Feb/19 ] |
|
Author: {'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}Message: |
| Comment by Githook User [ 01/Feb/19 ] |
|
Author: {'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}Message: |
| Comment by Githook User [ 01/Feb/19 ] |
|
Author: {'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}Message: |
| Comment by Githook User [ 31/Jan/19 ] |
|
Author: {'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}Message: |
| Comment by Jeffrey Yemin [ 31/Jan/19 ] |
|
OK, just wasn't sure if it was done and just not closed. |
| Comment by Ian Whalen (Inactive) [ 31/Jan/19 ] |
|
Sorry for the delay. Got stalled on 3.4+ branches because some of those docs are gone. Plus that whole wedding thing |
| Comment by Githook User [ 16/Jan/19 ] |
|
Author: {'username': 'IanWhalen', 'email': 'ian@mongodb.com', 'name': 'Ian Whalen'}Message: |
| Comment by Githook User [ 16/Jan/19 ] |
|
Author: {'username': 'IanWhalen', 'email': 'ian@mongodb.com', 'name': 'Ian Whalen'}Message: |
| Comment by Githook User [ 15/Jan/19 ] |
|
Author: {'username': 'IanWhalen', 'email': 'ian.whalen@gmail.com', 'name': 'Ian Whalen'}Message: |
| Comment by Cloud GitHub Webhooks [ 15/Jan/19 ] |
|
IanWhalen merged a pull request (JAVA-3134 Point QuickTour links to correct github pages) into the following branch: |
| Comment by Githook User [ 15/Jan/19 ] |
|
Author: {'username': 'IanWhalen', 'email': 'ian.whalen@gmail.com', 'name': 'Ian Whalen'}Message: |
| Comment by Cloud GitHub Webhooks [ 15/Jan/19 ] |
|
IanWhalen merged a pull request (JAVA-3134 Point GitHub links in docs to correct release branches) into the following branch: |