-
Notifications
You must be signed in to change notification settings - Fork 191
Add wiki pages for docs.rs #310
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
Conversation
r? @XAMPPRocky |
Note that the original wiki is here, I copied the files over in the first commit and made a few minor tweaks in the second. |
Co-Authored-By: XAMPPRocky <[email protected]>
Co-Authored-By: XAMPPRocky <[email protected]>
Note that mentioning individual was an intentional decision on my end: not everyone on the team has the knowledge of being pinged from infra if something is deeply wrong with the server. Maybe now it's true, but probably not in the future. |
Oh that's a good point - @GuillaumeGomez is definitely part of the team but probably wouldn't be comfortable working with the production server. |
@pietroalbini Do you feel that, that is covered by the fact there are some members who are marked as "Team Leader" and I would assume they would be comfortable with the server? Maybe the text could say "docs.rs leads" instead of teams. |
@XAMPPRocky well that's not guaranteed to be true. Basically the sole purpose of that section is "Someone from infra got paged and needs to ping a person who knows how to fix the problem", and I'd prefer that to be as streamlined as possible. |
@pietroalbini Well then maybe should this be it's own section and moved to the top level and then we keep the current docs.rs page under infra as is? |
Oh yeah, it would be good to have this content in its own "docs.rs" section! That infra section is meant to be a guide for infra team members to diagnose and fix problems in production, while the content this PR is adding is focused more on the development of docs.rs itself. |
@jyn514 Okay, so you move the content to |
@pietroalbini do you want me to keep the old page under infra? |
@jyn514 yeah, the old page should still be under infra. |
Addressed comments |
Great, thank you so much for your PR! |
* docsrs: Add wiki pages * docsrs: Update wiki pages * Add syntax highlighting for example Co-Authored-By: XAMPPRocky <[email protected]> * Improve docs.rs landing page * Link to team instead of website individual members Co-Authored-By: XAMPPRocky <[email protected]> * Link to website instead of GitHub * infra/docs/docs-rs/ -> docs-rs/ * fix table of contents * add back infra page * including summary Co-authored-by: XAMPPRocky <[email protected]>
Waiting on rust-lang/docs.rs#593, #307 since I jumped the gun and updated some of the pages already.Both merged.