Repository navigation
Delete the FAQ #27
Description
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.
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.
Activity
willingc commentedon Aug 14, 2016
A suggested workplan to address this issue:
brettcannon commentedon Aug 15, 2016
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.
Mariatta commentedon Dec 9, 2016
Is the FAQ ready to be removed? I can prepare a PR 😃
brettcannon commentedon Dec 9, 2016
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.
willingc commentedon Dec 9, 2016
@Mariatta If you have time to go through the FAQ, that would be awesome. Thanks!
brettcannon commentedon Dec 10, 2016
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)
Remove FAQ section
Remove FAQ section on github branch :)
Improve tracker docs about conflict resolution
Improve message about not reopening closed issue :)
Remove FAQ (#93)
willingc commentedon Jan 4, 2017
Thanks @Mariatta for the PR and @brettcannon for the merge 🍰
ezio-melotti commentedon Feb 23, 2017
A 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.
brettcannon commentedon Feb 24, 2017
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.
ezio-melotti commentedon Mar 2, 2017
This 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 :)
Remove FAQ (python#93)
Remove FAQ (#93)