-
Notifications
You must be signed in to change notification settings - Fork 7.8k
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
Move back mailinglist-rules.md and release-process.md back to docs #13536
Move back mailinglist-rules.md and release-process.md back to docs #13536
Conversation
Those are likely link from elsewhere so we could keep them
Can we just move all these docs-old files to docs directory for now and migrate them later to RST or to policy repo? Two directories for docs is a bit confusing indeed, specially if these will stay for longer period in the php-src repository. They probably also don't interfere with the documentation generation. Yes? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Migrating them makes sense, but I'm fine moving them to root in the meantime.
These were once already in the root directory and were moved to the docs directory to clean the extra long list of files in the root. Imagine downloading some repository and finding some docs directory and a bunch of markdown files in the root. Probably README.md would be a place to start, yes, but who knows. Maybe all those outdated Markdown files are important to read... but who has time for that, so let's just close the repo :) The php-src is again quite messy in my opinion for an easy entry to the open source project. A lot of CI subdirectories, config files all over the place, etc. And way too many bundled files. Just to understand this from another point of view. And we all know that once they are moved back to root, they will stay in root for a while. Unless there is an actual plan to move them to the RST and the docs directory. |
The thing is that those are still linked from elsewhere (especially the mailing list rules one: https://www.php.net/mailing-lists.php ) and the release notes one is used by RM's so it seems strange to have it in the docs-old when it's actually still important. I'm not sure where to move release notes - maybe different repo or maybe special path. In terms of mailing list rules, they should be probably moved to policies repo but it will require RFC. If we move it, I think we should stillkeep those files containing a link where it was moved to for a while with a note about new place. And we can maybe then remove it completely. |
Other docs are pretty much outdated (or need at least review) so docs-old might make sense for them. |
And one more thing I forgot to mention and to consider also with these docs files - there are also packages that copy documentation-alike files to a separate php-doc package. For example, this one https://pkgs.alpinelinux.org/contents?branch=edge&name=php82%2ddoc&arch=aarch64&repo=community |
For now, these two are still in the docs folder. See GH-13536.
Those are likely link from elsewhere so we could keep them where they were. If we really need to migrate them, there should be first some info where it got moved.
CC @iluuu1994