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

Add 3.5 and 4.0 to .doctrine-project.json #5771

Merged
merged 1 commit into from
Oct 18, 2022

Conversation

derrabus
Copy link
Member

Q A
Type documentation
Fixed issues N/A

Summary

Currently, the documentation for our dev branches in not rendered on the Doctrine website. In order to change that I'm proposing to include information about our dev branches in the .doctrine-project.json file.

{
"name": "3.4",
"branchName": "3.4.x",
"slug": "latest",
"slug": "current",
Copy link
Member

@morozov morozov Oct 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does the URL of the latest release documentation need to change? I believe, latest implies latest stable.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is consistent with other Doctrine projects (ORM, Persistence, Collections, …) where latest points to the dev branch.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot think of a software project outside of the Doctrine organization where latest would point to a dev branch. As a developer using the library, I most likely don't care about what's in the workings. I care about what I can use now.

This is especially important if the latest documentation is displayed by default or is linked in someone's bookmarks.

Copy link
Member

@morozov morozov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve as it's consistent with the rest of the projects but I don't believe it's right.

@derrabus derrabus merged commit 6544e68 into doctrine:3.4.x Oct 18, 2022
@derrabus derrabus deleted the chore/branch-metadata branch October 18, 2022 15:43
@derrabus
Copy link
Member Author

I agree, we should probably discuss the latest slug/alias.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants