DOC: Why do we have two README's for contributing? #15349
Comments
|
I think you have a typo in the links (they are the same). In any event, the canonical contributing guide is actually in the docs: http://pandas.pydata.org/pandas-docs/stable/contributing.html, but github has this 'feature' where they have a maybe best is to change |
|
though maybe the We had a discussion about this a while back but I don't remember. |
|
As far as I know, the one just a conversion of the other (so the But, it is actually stated in the same docs .. See the note in http://pandas.pydata.org/pandas-docs/stable/contributing.html#about-the-pandas-documentation |
|
We also have a wiki page about this: https://github.com/pandas-dev/pandas/wiki/Regenerating-CONTRIBUTING.md I don't feel strongly between the current situation or just putting a link in the contributing.md file to the docs |
|
@jreback : Good catch on the links. I updated them. In any case, I'm perfectly fine with just linking the |
|
I don't think you can do that. github only renders the |
|
That's not what I meant. I meant we should just say, "Go read the canonical docs" and provide the link to the file, that's all. |
|
@jorisvandenbossche : Thoughts on my proposal above? |
|
I would be fine with a link to the main contributing docs, instead of having a copy of the full content (can't directly remember the reason why we originally did it like this). But, I would do a bit more than just linking. Something like a very short summary, and linking to some different parts of the contributing docs. |
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes pandas-devgh-15349. [ci skip]
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes pandas-devgh-15349. [ci skip]
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes pandas-devgh-15349. [ci skip]
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes pandas-devgh-15349. [ci skip]
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes pandas-devgh-15349. [ci skip]
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes gh-15349.
Previously, we were trying to maintain two different copies of the documentation, one in the ".github" directory, and the other in the "docs/," which just imposes greater maintenance burden in the long-run. We now use the ".github" to refer to different portions of the "docs/" version with short summaries for ease of navigation. Closes pandas-devgh-15349.
This one under the documentation folder here and this one under the
.githubfolder here.I think we should just have one point to the other to avoid having to maintain it in two different places.
The text was updated successfully, but these errors were encountered: