Skip to content
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.

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

docs: fix error links #521

Merged
merged 3 commits into from Aug 10, 2023
Merged

docs: fix error links #521

merged 3 commits into from Aug 10, 2023

Conversation

QuakeWang
Copy link
Contributor

This link for getting started with docker has moved to https://www.docker.com/get-started/ .

Then some links in the document use relative paths, but cannot be accessed normally in GitHub, so add '...` prefix.

@QuakeWang QuakeWang requested review from nicecui and a team as code owners August 9, 2023 06:57
@QuakeWang QuakeWang changed the title doc: fix error links docs: fix error links Aug 9, 2023
Copy link
Collaborator

@nicecui nicecui left a comment

Choose a reason for hiding this comment

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

Thank you very much for your contribution! Your help ensures that the Docker link will be correct.

However, it may not be necessary to make changes to relative paths. We use paths like /user-guide or /reference to reduce errors in internal hierarchical documentation. For example, it is easy to make mistakes when writing links to reference at /user-guide/clients/sdk/go.md, that would be ../../../reference/xxx.md. In contrast, we can write /reference/xxx.md, which is simpler and less prone to errors.

We hope that all links will be recognized correctly on GitHub. However, our main priority is to publish the repository to https://docs.greptime.com without errors, with minimal need for considering link corrections. To achieve this, we require that all documents follow the same specification. Therefore, links to resource root directories in all documents should be written as /reference, /user-guide, and so on.

Thank you for your understanding and contribution! Expecting the modified PR.

@QuakeWang
Copy link
Contributor Author

OK, got it. I will update it later : )

Copy link
Contributor Author

@QuakeWang QuakeWang left a comment

Choose a reason for hiding this comment

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

@nicecui PTAL

Copy link
Collaborator

@nicecui nicecui left a comment

Choose a reason for hiding this comment

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

👍

@xtang xtang merged commit 2658c32 into GreptimeTeam:main Aug 10, 2023
3 checks passed
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.

None yet

3 participants