Skip to content

fixed link to contributing doc #993

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Sep 19, 2022
Merged

fixed link to contributing doc #993

merged 5 commits into from
Sep 19, 2022

Conversation

@jhumbug
Copy link
Contributor

@jhumbug jhumbug commented Mar 11, 2021

Fixed link to the contributing doc in the Tutorial

@spectacle-ci spectacle-ci temporarily deployed to staging-993 March 11, 2021 20:58 Inactive
@jhumbug
Copy link
Contributor Author

jhumbug commented Mar 15, 2021

After submitting this PR, I noticed that on staging the built docs are stripping .md from any markdown external link. So not only is that contrib link still not exactly working because of that, any other links to markdown files in the docs are 404ing.

It seems to be because of a react-static plugin as described here: https://github.com/kitten/react-static-plugin-md-pages#relative-links-fixes. I believe it's only supposed to strip relative links, but these aren’t relative and still getting stripped. So we may want to address that before merging this in.

gksander
gksander approved these changes Sep 19, 2022
View reviewed changes
Copy link
Contributor

@gksander gksander left a comment

Choose a reason for hiding this comment

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

Nice, good catch!

@github-actions github-actions bot temporarily deployed to staging-993 September 19, 2022 18:08 Inactive
@gksander
Copy link
Contributor

gksander commented Sep 19, 2022

Uh oh, looks like Docusaurus found some broken links. If you run a local docusaurus build, you should be able to catch the broken links locally before it gets to CI.

@github-actions github-actions bot had a problem deploying to staging-993 September 19, 2022 18:08 Failure
@fritz-c
Copy link
Contributor

fritz-c commented Sep 19, 2022

Yeah, I had been running it locally with the docusaurus start command but it didn't catch that double-.md one for whatever reason.

@fritz-c fritz-c merged commit 4e45406 into main Sep 19, 2022
@fritz-c fritz-c deleted the fix/docs-contrib-link branch September 19, 2022 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@carloskelly13 carloskelly13 carloskelly13 approved these changes

@gksander gksander gksander approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jhumbug @gksander @fritz-c @carloskelly13 @spectacle-ci