-
Notifications
You must be signed in to change notification settings - Fork 38
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
Add Contributor Section #92
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you're fixing typos, here are more:
- "life blood" should be "lifeblood"
- "desrcribe" should be "describe"
- "the purpose of your pr" should be "the purpose of your PR"
All at "Contribution Guidelines"
Thanks, fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks pretty good. The main thing is that we should decide our audience for who is contributing, and make sure whoever can access this section can also access all the links posted.
Understanding the rST-Primer Repo | ||
--------------------------------- | ||
|
||
The GitHub ``rst-primer`` repository can be found on GitHub at the following address: | ||
|
||
- https://github.com/FIRST-Tech-Challenge/rst-primer/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we using a private repository as the example? I think that everyone should be able to access all the links we use. This repo could be a better example since it's the repo that people need to work with directly in order to contribute, and it's public.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pr is not yet complete and we are still in the process of migrating references to the rst-primer
repository. This was initially used as internal documentation and is now being migrated to be documentation for all. If you could redo the references to rst primer (images and text) that would be much appreciated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, I can work on redoing references. Should they be to this repo or somewhere else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! They should all be to this repo.
.. figure:: images/vscode-trust.png | ||
:alt: Trust | ||
:align: center | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was prompted to install extensions and then a bunch of dependencies for said extensions. Maybe document what extensions are needed/recommended?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree. I believe that we added the recommendations for extensions in the .vscode files after creating this document.
.. note:: | ||
It is assumed that you have created a GitHub account and been given the proper | ||
permissions to work within this repository for training. If you can read this, | ||
you probably have, but double-check with your friendly FTC Support person. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this documentation not going to appear on a public website? I think we need to decide if we want to allow anyone to contribute or not. If we do, then there shouldn't be a need to have permissions granted before you can start contributing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The goal of ftcdocs is to allow any and all to contribute without any permissions being granted. The final version will reflect this goal. This is another artifact because of this documentations origins as internal documentation.
I'll go through the "local" tutorial again for next week with my new laptop. |
… code block, not actual sections that mess up following sections in the ToC)
No description provided.