[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
At some point the versions of hugo changed from v0.13 to v0.25 - so both would be required to rebuild the documentation.

  • Check out the maintenance branch eg: 3.1.x
  • In docs/reference/config.toml update the source code version to point to the maintenance branch.
  • In docs/reference/data/mongodb.toml update the githubBranch to point to the maintenance branch.
  • Commit the changes and push to the maintenance branch
  • Regenerate the code and copy over the code in the gh-pages/3.1 directory.

2. Just change each release docs in the gh-pages:
Grep for the incorrect links and update them eg:

  • grep -rl 'mongo-java-driver/tree/master' ./3.1 | xargs sed -i 's/mongo-java-driver\/tree\/master/mongo-java-driver\/tree\/3.1.x/g'

*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.
eg: https://github.com/mongodb/mongo-java-driver/blob/3.1.x/driver/src/examples/tour/QuickTour.java#L57 and the async version.



 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

JAVA-3134
Branch: 3.10.x
https://github.com/mongodb/mongo-java-driver/commit/3321d3c76fdb08c2c095c6493ede41a9bf66dde7

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

JAVA-3134
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/95f622d8c219c31117348735cebaf9abc5be4bb5

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: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.9.x
https://github.com/mongodb/mongo-java-driver/commit/2c046cf810885fefb590bb48564c588cd0169129

Comment by Githook User [ 01/Feb/19 ]

Author:

{'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.8.x
https://github.com/mongodb/mongo-java-driver/commit/515e7c12a1e90b7ebd8e03ac2160a896ebd2bf0b

Comment by Githook User [ 01/Feb/19 ]

Author:

{'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.7.x
https://github.com/mongodb/mongo-java-driver/commit/b6cb9e5ea9c2a0142fe89d0ab4ad46d1335393ee

Comment by Githook User [ 01/Feb/19 ]

Author:

{'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.6.x
https://github.com/mongodb/mongo-java-driver/commit/0b010e6065e624f54af28973486748f10f1defcb

Comment by Githook User [ 01/Feb/19 ]

Author:

{'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.5.x
https://github.com/mongodb/mongo-java-driver/commit/05311b23a015445da40a53f4af7c3ff13fdd455c

Comment by Githook User [ 31/Jan/19 ]

Author:

{'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.4.x
https://github.com/mongodb/mongo-java-driver/commit/7d87aaf54180d193f88769238371e8affd19ce7d

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 Will hopefully finish these patches this weekend.

Comment by Githook User [ 16/Jan/19 ]

Author:

{'username': 'IanWhalen', 'email': 'ian@mongodb.com', 'name': 'Ian Whalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: 3.3.x
https://github.com/mongodb/mongo-java-driver/commit/e5d5df8d6790b6400cb21dd29b8042108f9b0cdf

Comment by Githook User [ 16/Jan/19 ]

Author:

{'username': 'IanWhalen', 'email': 'ian@mongodb.com', 'name': 'Ian Whalen'}

Message: JAVA-3134 Point QuickTour links to correct GitHub pages
Branch: 3.2.x
https://github.com/mongodb/mongo-java-driver/commit/52987e6ae9e5e124d8df051b8ea1e4963cb418db

Comment by Githook User [ 15/Jan/19 ]

Author:

{'username': 'IanWhalen', 'email': 'ian.whalen@gmail.com', 'name': 'Ian Whalen'}

Message: JAVA-3134 Point QuickTour links to correct github pages
Branch: 3.1.x
https://github.com/mongodb/mongo-java-driver/commit/5f54da8144fe6d928c726060544b76b2034f4b8c

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:
3.1.x: 5f54da8144fe6d928c726060544b76b2034f4b8c

Comment by Githook User [ 15/Jan/19 ]

Author:

{'username': 'IanWhalen', 'email': 'ian.whalen@gmail.com', 'name': 'Ian Whalen'}

Message: JAVA-3134 Point GitHub links in docs to correct release branches
Branch: gh-pages
https://github.com/mongodb/mongo-java-driver/commit/5afe0bbee043b03bf1880013b4af813cabcb25a1

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:
gh-pages: 5afe0bbee043b03bf1880013b4af813cabcb25a1

Generated at Thu Feb 08 08:58:52 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.