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.

Sign up for GitHub

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

Jump to bottom

Post-hacktoberfest chore: move docs to folders #6164

Closed
eshellman opened this issue Oct 11, 2021 · 2 comments · Fixed by #6614
Closed

Post-hacktoberfest chore: move docs to folders #6164

eshellman opened this issue Oct 11, 2021 · 2 comments · Fixed by #6614
Assignees
@eshellman @davorpa
Labels
PR requested Issues that can be addressed with a new PR

Comments

@eshellman
Copy link
Collaborator

Success: we have lots of translations.
Downside: they move the README far below the fold; filenames are difficult to scan.
Suggested solution: move the docs, other than README, to subfolders.

At the same time, maybe consolidate links to them. Does a visitor to an Arabic HOWTO really need the link to the Chinese HOWTO? These links are causing a lot of merge conflicts, too.
@davorpa davorpa mentioned this issue Oct 11, 2021
Closed
39 tasks
@davorpa
Copy link
Member

davorpa commented Oct 11, 2021 •
edited
Loading

My two pennies...

Without want discriminate any language or country, I'd opt to leave at least in root:

  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • LICENSE

They are important in some GitHub parts. E.g. footer:

(i) Remember, contributions to this repository should follow its contributing guidelines and code of conduct.

I'm not be able to find if can be configured using some file in .github folder Acceptable folders (see GitHub docs): /, /docs, /.github

@davorpa davorpa added the PR requested Issues that can be addressed with a new PR label Oct 17, 2021
@davorpa davorpa mentioned this issue Nov 15, 2021
Closed
9 tasks
@eshellman
Copy link
Collaborator Author

duplicate of #6590 addressed by #6614

@davorpa davorpa linked a pull request Feb 16, 2022 that will close this issue
move the translated documentation files to a docs folder #6614
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eshellman eshellman

@davorpa davorpa

Labels
PR requested Issues that can be addressed with a new PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

move the translated documentation files to a docs folder EbookFoundation/free-programming-books
2 participants
@eshellman @davorpa