Skip to content

Fixing links (new PR for approved PR #136 after rebasing)#231

Closed
jaret-basden wants to merge 0 commit intoapache:mainfrom
jaret-basden:main
Closed

Fixing links (new PR for approved PR #136 after rebasing)#231
jaret-basden wants to merge 0 commit intoapache:mainfrom
jaret-basden:main

Conversation

@jaret-basden
Copy link

IMPORTANT: This PR is a new PR for PR #136 Fixing links. PR #136 has already been approved. Per RussellSpitzer's comment in PR #136, I rebased. Correct me if I'm wrong but it appears now I need to open a new PR to merge the changes.

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

  • docs\command-line-interface.md: Updated a link so it is an absolute link that points to the Redocly output. Currently, it is a relative link that points to the GitHub-preview Markdown file for the content.
  • docs/entities.md: Updated some links so they use an absolute link. Currently, they use a relative link, which doesn't work with the Redocly output (broken link).
  • docs/overview.md: Updated some links so they they point to an id attribute to align with the Redocly output. Currently, they point to a raw .md file in the /docs folder. The Redocly output combines .md files in the /docs folder into a single index.html file.
  • docs/quickstart.md:

Fixes # (issue): N/A

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

  • I tested the updated links locally in my browser (Chrome).

Checklist:

Please delete options that are not relevant.

  • I have performed a self-review of my code
  • My changes generate no new warnings
  • I have signed and submitted the ICLA and if needed, the CCLA. See Contributing for details.

Copy link
Member

@jbonofre jbonofre left a comment

Choose a reason for hiding this comment

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

Overall ok, I just left a comment about polaris.io linking.

Copy link
Member

Choose a reason for hiding this comment

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

I think it would be better to wait the documentation moved to polaris.apache.org (else we will have to change again).
Even if polaris.io will redirect to polaris.apache.org, I think it's cleaner to directly link to polaris.apache.org.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants