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

Rename getting-the-playbook.md to getting-playbook.md #4084

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

luixxiul
Copy link
Collaborator

The conventional practice is not to include an article to the file name, and we do not have to make an exception here, though the file has existed since years.

The conventional practice is not to include an article to the file name, and we do not have to make an exception here, though the file has existed since years.

Signed-off-by: Suguru Hirahara <[email protected]>
@luixxiul luixxiul added the docs This issue is related to documentation label Feb 20, 2025
@spantaleev
Copy link
Owner

getting-playbook seems kind of incomplete to me, but maybe it's fine and I can get used to it.

Sometimes, I've been thinking of renaming all other configuring-playbook-*.md files, because the configuring-playbook- prefix is quite long.

This is all a backward compatibility break though. We'll break all our own links (which we can fix more easily), but we'll also break links for people linking from outside.

Another idea may be to move the configuration-related documentation to a configuration/ subdirectory. There may even be multiple levels for better organization and "fewer doc files per directory", instead of the current state (lots of files all in the same place). Examples:

  • docs/configuration/bridge/mautrix-whatsapp
  • docs/tooling/ansible.md
  • docs/tooling/just.md
  • docs/maintenance/synapse.md

@luixxiul luixxiul marked this pull request as draft February 21, 2025 03:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants