Repository navigation
Delete the FAQ #27
Description
Activity
A suggested workplan to address this issue:
- Verify that any useful content (esp. section 29.1 Communications) is found elsewhere in the devguide. If not, migrate that content to an appropriate devguide section.
- 29.1 Communication
- 29.2 Version control
- 29.3 SSH
- 29.4 General
- Remove all FAQ content and references to the FAQ.
I don't think we should document version control stuff outside of our workflow as there's enough content on git online, so I say just drop that section. The same I think goes for SSH.
Reacted by Carol Willing and Kushal DasIs the FAQ ready to be removed? I can prepare a PR 😃
Someone should go through the FAQ to see if there's any relevant info in there that isn't either easily/better found elsewhere online or that is replicated in the proper place somewhere else in the devguide. So I don't know if it's ready yet until that's occurred.
Yes, if that wasn't clear, it's open to anyone to try and tackle. 😄 (long list of todos today that I'm trying to rush through)
Reacted by Carol Willing and MariattaThanks @Mariatta for the PR and @brettcannon for the merge 🍰
Reacted by MariattaA bit late to the party, but just yesterday I was looking for faq.rst and then accidentally came across this issue.
I think removing it was a bad idea, and just by reading the diff I got answers to a few questions I had that are currently not covered in the devguide.I also disagree with the rationale:
It's not necessary as it was written for a time where we used version control systems that aren't as widely used or documented at git.Even though I was familiar with HG (I wrote several of those FAQs myself), I often went back to them to look up the exact list of commands I needed to solve a particular problem. While it's true that the same answers can be found online, there are several possible workflows and variations that need to be adapted to our workflow and repo structure. The commands in the FAQ were easy to find and copy/paste.
I think the general feeling has been that instead of a FAQ we should have a doc(s) that cover scenarios and include the appropriate instructions. So that would mean if you were looking for something and it wasn't in the relevant doc that covered that scenario then that doc needs an update instead of a random entry in an FAQ.
Reacted by Mariatta and Carol WillingThis works for me as long as the commands are documented and easy to find. You could argue that each scenario answer a specific question though :)
Reacted by Brett Cannon
It's not necessary as it was written for a time where we used version control systems that aren't as widely used or documented at git. All references should also be removed.