Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Delete the FAQ #27
Delete the FAQ #27
Comments
|
A suggested workplan to address this issue:
|
|
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. |
|
Is 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. |
|
@Mariatta If you have time to go through the FAQ, that would be awesome. Thanks! |
|
Yes, if that wasn't clear, it's open to anyone to try and tackle. |
Move contents from FAQ to other sections of the guide Remove sections about version control and SSH Remove sections that were found elsewhere Closes python#27
Move the following items from FAQ: - disagreement with issue resolution -> tracker.rst - regenerating configure -> setup.rst - porting python to a new platform -> porting.rst (new file) In index.rst: - change any reference to FAQ into Help. - remove faq from TOC - add porting to TOC Closes python#27
Drop the mention of python-ideas Forbid the reopening of issues closed by core dev :) Closes python#27
Move the following items from FAQ: - disagreement with issue resolution -> tracker.rst - regenerating configure -> setup.rst - porting python to a new platform -> porting.rst (new file) In index.rst: - change any reference to FAQ into Help. - remove faq from TOC - add porting to TOC Closes #27
|
Thanks @Mariatta for the PR and @brettcannon for the merge |
|
A bit late to the party, but just yesterday I was looking for faq.rst and then accidentally came across this issue. I also disagree with the rationale: 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. |
|
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 :) |
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.
The text was updated successfully, but these errors were encountered: