Skip to content
This repository has been archived by the owner on May 31, 2020. It is now read-only.

The links to contributor's guide and others appear to be broken #828

Open
pranavmodx opened this issue Oct 5, 2019 · 3 comments
Open

The links to contributor's guide and others appear to be broken #828

pranavmodx opened this issue Oct 5, 2019 · 3 comments

Comments

@pranavmodx
Copy link

3 of the links given in the the section : 'docs/how-to/contribute-code.rst' appear to be broken. I could help fix this by replacing them with the correct links if someone could point me to where they are obtained from.

@freakboy3742
Copy link
Member

Thanks for the report! These links obviously got broken during a recent docs refactor.

The correct destinations should be:

  • "Separate contributors guide" -> The contribute-docs.rst file in the same folder
  • "Getting started guide" -> tutorial 0
  • "Set up your development environment" -> the development-env.rst file in the same folder

For bonus points; adding a build test that validates that documentation is accurate would be extremely helpful.

@pranavmodx
Copy link
Author

I have updated the links to correct destinations.
I looked at the test sections but can't seem to figure out a way for adding a build test or how it works. Could you please guide me through it?

@freakboy3742
Copy link
Member

So - Adding a build test would mean adding a CI stage that does a build of the documentation to confirm that there are no errors. We're in the process of moving all our CI to Github Actions; if you wanted to try adding a Github actions configuration for Batavia, replacing the current BeeKeeper configuration, but adding a documentation step, that would be really helpful.

As a point of reference, Briefcase has a Github Actions configuration in it's v0.3 branch

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants