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

doc: fix GitHub PR link in getting-started.md #815

Closed
wants to merge 2 commits into from
Closed

doc: fix GitHub PR link in getting-started.md #815

wants to merge 2 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Jan 18, 2024

The 'Getting Started' documentation page has a section about replacing the GitHub PR URL with reviewstack, but the link in Markdown is parsed as GitHub flavored Markdown and shows just facebook/react#25506 instead of https://github.com/facebook/react/pull/25506 which is slightly confusing. This change fixes that to the full intended URL is displayed.

See: https://sapling-scm.com/docs/introduction/getting-started#browsing-pull-requests
image

The 'Getting Started' documentation page has a section about replacing the GitHub PR URL with reviewstack, but the link in Markdown is parsed as GitHub flavored Markdown and shows just `facebook/react#25506` instead of `https://github.com/facebook/react/pull/25506` which is slightly confusing. This change fixes that to the full intended URL is displayed.
@facebook-github-bot
Copy link
Contributor

Hi @pseudomata!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Wrapping the link as an inline code block prevents the GitHub flavored Markdown parsing it into a PR reference and preserves the full URL.
@facebook-github-bot
Copy link
Contributor

@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@quark-zju
Copy link
Contributor

Thanks! I removed the code span so they render as regular text.

@ghost
Copy link
Author

ghost commented Jan 18, 2024

In my first commit I didn't wrap them in a code span but they still appeared to render as org/project#1 instead of github.com/org/project/pull/1 (at least in the GitHub diff for the rendered Markdown). Since Docusaurus uses GitHub flavored Markdown I suspect it would be the same without the code span.

@quark-zju
Copy link
Contributor

they still appeared to render as org/project#1 instead of github.com/org/project/pull/1

I noticed that. I found appending a space also works so I used that instead.

@quark-zju
Copy link
Contributor

I think this was pushed as fe03a17. Not sure why the bot didn't close this...

@quark-zju quark-zju closed this Jan 18, 2024
pull bot pushed a commit to kkpan11/sapling that referenced this pull request Jan 19, 2024
Summary:
The 'Getting Started' documentation page has a section about replacing the GitHub PR URL with reviewstack, but the link in Markdown is parsed as GitHub flavored Markdown and shows just `facebook/react#25506` instead of `https://github.com/facebook/react/pull/25506` which is slightly confusing. This change fixes that to the full intended URL is displayed.

See: https://sapling-scm.com/docs/introduction/getting-started#browsing-pull-requests
![image](https://github.com/facebook/sapling/assets/132238190/89880bb4-b13f-4980-9e9c-c1a446dfbc4d)

Pull Request resolved: facebook#815

Reviewed By: evangrayk

Differential Revision: D52875007

Pulled By: quark-zju

fbshipit-source-id: 4c674ae6f18cb9664ac5c639d35e92cc0ab6c5ed
@ghost
Copy link
Author

ghost commented Jan 19, 2024

Ah cool. Thank you @quark-zju!

@ghost ghost deleted the patch-1 branch January 19, 2024 16:50
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.

2 participants