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

Discuss renaming doc/guides #23315

Closed
gabrielschulhof opened this issue Oct 7, 2018 · 4 comments
Closed

Discuss renaming doc/guides #23315

gabrielschulhof opened this issue Oct 7, 2018 · 4 comments
Labels
discuss Issues opened for discussions and feedbacks. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. stalled Issues and PRs that are stalled.

Comments

@gabrielschulhof
Copy link
Contributor

In #23287 (comment), @Trott wrote:

Also: The whole "things called 'guides' are in two different places and mean subtly different things, and oh yeah the website is generated in this repo over here except for the docs which are generated over here".... If there's some way that information could have been something could have been surfaced naturally, I'd love to hear what it is. Because that stuff is confusing and probably only a few people know it.

Maybe the guides directory in this repo can be renamed to something that makes it clear they are internal to the project and/or moved out of docs?

Maybe a bot can comment on any PR that adds a new file to the docs/guides letting the user know that these guides are for internal use and if they meant to create something for end users, then they should close this PR and open a new PR over in this other repo?

Other ideas?

@gabrielschulhof
Copy link
Contributor Author

doc/contribution_guides?

@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. discuss Issues opened for discussions and feedbacks. meta Issues and PRs related to the general management of the project. labels Oct 7, 2018
@richardlau
Copy link
Member

Maybe the guides directory in this repo can be renamed to something that makes it clear they are internal to the project and/or moved out of docs?

We could also put a readme.md in docs/guides for anyone browsing through the GitHub UI?

@mhdawson
Copy link
Member

mhdawson commented Oct 9, 2018

I like the idea of a bot with auto comments.

@Trott
Copy link
Member

Trott commented Nov 6, 2018

This conversation seems to have stalled or run its course or something. Feel free to re-open if I'm wrong to close it. And, of course, PRs can also be opened for any desired changes.

@Trott Trott closed this as completed Nov 6, 2018
@Trott Trott added the stalled Issues and PRs that are stalled. label Nov 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issues opened for discussions and feedbacks. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. stalled Issues and PRs that are stalled.
Projects
None yet
Development

No branches or pull requests

5 participants