Skip to content

Fix broken links in docs, add broken link checker.#7658

Merged
fjy merged 1 commit intoapache:masterfrom
gianm:fix-broken-links
May 15, 2019
Merged

Fix broken links in docs, add broken link checker.#7658
fjy merged 1 commit intoapache:masterfrom
gianm:fix-broken-links

Conversation

@gianm
Copy link
Copy Markdown
Contributor

@gianm gianm commented May 14, 2019

Also adds back insert-segment-to-db.md with some docs about why and
when it was removed (in #6911).

Some of these changes should be backported to 0.15.0.

Also adds back insert-segment-to-db.md with some docs about why and
when it was removed (in apache#6911).
@gianm gianm added this to the 0.15.0 milestone May 14, 2019
Comment thread docs/_bin/deploy-docs.sh

if [ -n "$opt_docs" ] ; then
# Check for broken links
"$src/docs/_bin/broken-link-check.py" "$src/docs/content" "$src/docs/_redirects.json"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As far as I could tell, this script doesn't modify anything and just prints out the broken links/redirects, what is the purpose of calling it here? Should we be catching the exit code and have it cause a failure of some sort if it has non-zero exit code?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The bash script is running with mode -e so if any subcommand exits nonzero, it will automatically stop.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oops! I see that now, my bad 👍

## Home

The home view provide a high level overview of the cluster. Each card is clickable and links to the appropriate view. The legacy menu allows you to go to the [legacy coordinator and overlord consoles](./management-uis#legacy-consoles) should you need them.
The home view provide a high level overview of the cluster. Each card is clickable and links to the appropriate view. The legacy menu allows you to go to the [legacy coordinator and overlord consoles](./management-uis.html#legacy-consoles) should you need them.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: this isn't your fault, but 'The home view provides ...'

Suggested change
The home view provide a high level overview of the cluster. Each card is clickable and links to the appropriate view. The legacy menu allows you to go to the [legacy coordinator and overlord consoles](./management-uis.html#legacy-consoles) should you need them.
The home view provides a high level overview of the cluster. Each card is clickable and links to the appropriate view. The legacy menu allows you to go to the [legacy coordinator and overlord consoles](./management-uis.html#legacy-consoles) should you need them.

@fjy fjy merged commit 0352f45 into apache:master May 15, 2019
jon-wei pushed a commit to jon-wei/druid that referenced this pull request May 17, 2019
Also adds back insert-segment-to-db.md with some docs about why and
when it was removed (in apache#6911).
fjy pushed a commit that referenced this pull request May 17, 2019
Also adds back insert-segment-to-db.md with some docs about why and
when it was removed (in #6911).
@fjy fjy mentioned this pull request May 23, 2019
jihoonson pushed a commit to implydata/druid-public that referenced this pull request Jun 4, 2019
…che#7689)

Also adds back insert-segment-to-db.md with some docs about why and
when it was removed (in apache#6911).
jihoonson pushed a commit to implydata/druid-public that referenced this pull request Jun 26, 2019
Also adds back insert-segment-to-db.md with some docs about why and
when it was removed (in apache#6911).
@gianm gianm deleted the fix-broken-links branch September 23, 2022 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants