Skip to content

Update online docs URL. #434

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

Open
johnsmartco wants to merge 2 commits into
base: 1.x
Choose a base branch
from
Open

Update online docs URL. #434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bb3863
Update online docs URL.
johnsmartco Jul 19, 2022
d53dbe7
rm onlineDocs from footer
johnsmartco Jul 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The executable jar can be executed with a command like `java -jar dsbulk-distrib

## Documentation

The most up-to-date documentation is available [online][onlineDocs].
The most up-to-date documentation is available [online](https://docs.datastax.com/en/dsbulk/docs/1.9.0/dsbulkAbout.html).
Copy link
Contributor

@adutra adutra Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you are inlining the link, please remove the "footpage link" at the bottom of the page:

[onlineDocs]:https://docs.datastax.com/en/dsbulk/doc/

Copy link
Contributor

@adutra adutra Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, couldn't we avoid hard-coding 1.9 in the URL? E.g. by using a "latest" redirect?

Copy link
Author

@johnsmartco johnsmartco Jul 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the /latest/ instead of /1.9.0/, that proposed scheme was objected to by a prior generation of doc leads. Something about customers assuming their version was the "latest" and complained to Support that they couldn't get a doc'd feature (introduced in a more recent release) to work. For the moment I'll need to hardcode the /1.9.0/ but you raise a fair point.

Copy link
Author

@johnsmartco johnsmartco Jul 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes will remove the [onlineDocs] reference from the footer. Thanks for spotting it.

Copy link
Contributor

@adutra adutra Aug 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the customers objections. But in the present case, we are considering DSBulk's own in-tree README file. Moreover, the link is being described as "the most up-to-date documentation". If we hard-code 1.9.0 here, the README file and this description will become outdated as soon as we publish a 1.10 release. Are we sure this is what we want?


We also recommend reading the series of blog posts made by
[Brian Hess](https://github.com/brianmhess); they target a somewhat older version of DSBulk, but
Expand Down Expand Up @@ -358,7 +358,6 @@ available on the command-line via the `help` subcommand.

`dsbulk help connector.csv`

[onlineDocs]:https://docs.datastax.com/en/dsbulk/doc/
[HOCON]:https://github.com/lightbend/config/blob/master/HOCON.md
[DataStax Bulk Loader Pt. 1 — Introduction and Loading]: https://www.datastax.com/blog/2019/03/datastax-bulk-loader-introduction-and-loading
[DataStax Bulk Loader Pt. 2 — More Loading]: https://www.datastax.com/blog/2019/04/datastax-bulk-loader-more-loading
Expand Down