Skip to content
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

Delete the FAQ #27

Closed
brettcannon opened this issue Jul 26, 2016 · 10 comments
Closed

Delete the FAQ #27

brettcannon opened this issue Jul 26, 2016 · 10 comments

Comments

@brettcannon
Copy link
Member

brettcannon commented Jul 26, 2016

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.

@willingc
Copy link
Collaborator

willingc commented Aug 14, 2016

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.

@brettcannon
Copy link
Member Author

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
Copy link
Member

Mariatta commented Dec 9, 2016

Is the FAQ ready to be removed? I can prepare a PR 😃

@brettcannon
Copy link
Member Author

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
Copy link
Collaborator

willingc commented Dec 9, 2016

@Mariatta If you have time to go through the FAQ, that would be awesome. Thanks!

@brettcannon
Copy link
Member Author

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)

Mariatta added a commit to Mariatta/devguide that referenced this issue Jan 1, 2017
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
Mariatta added a commit to Mariatta/devguide that referenced this issue Jan 3, 2017
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
Mariatta added a commit to Mariatta/devguide that referenced this issue Jan 4, 2017
Drop the mention of python-ideas
Forbid the reopening of issues closed by core dev

:)

Closes python#27
Mariatta added a commit to Mariatta/devguide that referenced this issue Jan 4, 2017
brettcannon pushed a commit that referenced this issue Jan 4, 2017
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
@willingc
Copy link
Collaborator

willingc commented Jan 4, 2017

Thanks @Mariatta for the PR and @brettcannon for the merge 🍰

@ezio-melotti
Copy link
Member

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
Copy link
Member Author

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
Copy link
Member

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 :)

AA-Turner pushed a commit to AA-Turner/devguide that referenced this issue Jun 17, 2022
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
kitarefake added a commit to kitarefake/devguide that referenced this issue Jul 15, 2024
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/devguide#27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants