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

Documentation broken link: Internal link: /content/docs/website #3736

Closed
gabek opened this issue May 12, 2024 · 4 comments
Closed

Documentation broken link: Internal link: /content/docs/website #3736

gabek opened this issue May 12, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@gabek
Copy link
Member

gabek commented May 12, 2024

Broken link found in Owncast documentation

First, please verify that this link or asset is actually broken by testing the correct page that is in production at https://owncast.online. Then you can fix or remove the broken link Internal link: /content/docs/website from content/docs/_index.md.

However, this is a link internal to the site. So make sure you understand how the site is organized using Hugo, our static site generator.

You can find the Owncast documentation site repository at https://github.com/owncast/owncast.github.io, and that is where you would make any fixes to broken links, or documentation in general. Thank you for helping improve our documentation!

Open documentation repository in editor

Source file: https://github.com/owncast/owncast.github.io/tree/master/content/docs/_index.md

  • Failed: Cannot find file
@gabek gabek added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 12, 2024
Copy link

Good First Issue

This item was marked as a good first issue because of the following:

  • It's self contained as a single feature or change.
  • Is clear when it's complete.
  • You do not need deep knowledge of Owncast to accomplish it.

Next Steps

  1. Comment on this issue before starting work so it can be assigned to you. Also, this issue may have been filed with limited detail or changes may have occurred that are worth sharing with you before you start work.
  2. Drop by our community chat if you'd like to be involved in more real-time discussion around Owncast to talk about this change.
  3. Follow the project's getting started tips to make sure you can build and run the project from source.

Notes

  • Development takes place on the develop branch.
  • We use Storybook for testing and developing React components. npm run storybook. A hosted version is available for viewing.
  • If you need to install the Go programming language to run the Owncast backend it's simple from here.
  • Active contributors get an Owncast t-shirt! Ask about it if you feel like you've been contributing and haven't yet been given one.

New to Git?

If you're brand new to Git you may want a short primer about the Fork -> Commit -> Pull Request workflow that enables changes to get made collaboratively using git. Visit the First Contributions project to learn step-by-step how to commit a change to a Git repository such as this one.

@vvu11
Copy link

vvu11 commented May 13, 2024

Hi I would like to work on this issue, please assign to me

@vvu11
Copy link

vvu11 commented May 13, 2024

actually, it seems as though the links are all working on the website. It does show an error on github when I attempted to click on them on content/docs/_index.md

@gabek
Copy link
Member Author

gabek commented May 13, 2024

Thanks for looking! This process is automated and opens these when a check fails, so it's always important to check it first. Thanks for doing so!

@gabek gabek closed this as not planned Won't fix, can't repro, duplicate, stale May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants