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

fix: update links in DOCS #6244

Closed

Conversation

junha-ahn
Copy link

@junha-ahn junha-ahn commented Dec 31, 2023

Motivation

Update broken links in the Document

Description

  1. There is no CLI document in the docs/pages so Removed a line
  2. And Update two links (CONTRIBUTING, SECURITY)

Steps to test or reproduce

No test Here.

@junha-ahn junha-ahn requested a review from a team as a code owner December 31, 2023 11:19
@CLAassistant
Copy link

CLAassistant commented Dec 31, 2023

CLA assistant check
All committers have signed the CLA.

@junha-ahn junha-ahn changed the title fix: Update link in DOCS fix: update link in DOCS Dec 31, 2023
@junha-ahn junha-ahn changed the title fix: update link in DOCS fix: update links in DOCS Dec 31, 2023
@matthewkeil
Copy link
Member

Thank you very much for the submission!! We actually just updated our docs a couple weeks ago and noticed the broken links. They are updated here and I have used this PR as an opportunity to test our new workflow to deploy those changes. Thank you again for your contribution.

Please see the notes below.

  1. There is no CLI document in the docs/pages so Removed a line

The page that link points to is generated at docs build time.

fs.writeFileSync(path.join(folder, `${cmd.command}-cli.md`), docstring);

  1. And Update two links (CONTRIBUTING, SECURITY)

Those two pages are moved in from the root of the repo to be included with the docs at build time.

cp CONTRIBUTING.md $DOCS_DIR/pages/contribution/getting-started.md

Because these changes are not needed I am going to close this PR but please feel free to submit anything else you find as our docs are fresh off a full rewrite and there may still be some errors in there.

@matthewkeil matthewkeil closed this Jan 2, 2024
@junha-ahn junha-ahn deleted the junha-ahn/fix-doc-links branch January 2, 2024 15:02
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.

3 participants