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 dummy title to the sidebar before checking docs #10824

Merged
merged 1 commit into from
Jul 11, 2023

Conversation

greg0ire
Copy link
Member

@greg0ire greg0ire commented Jul 7, 2023

The way we have our docs, the sidebar is a separate document and as such, needs a title. Let us prepend a dummy title until the guides-cli provides a way to ignore that particular error.

The way we have our docs, the sidebar is a separate document and as
such, needs a title. Let us prepend a dummy title until the guides-cli
provides a way to ignore that particular error.
@SenseException
Copy link
Member

What's the result of the change? That "Dummy Page" will be shown?

@greg0ire
Copy link
Member Author

greg0ire commented Jul 9, 2023

The result of this change is the disappearance of a warning about the title missing, and affects only the CI. It doesn't impact what is show on the website, since that dummy title is never under version control. I've discussed this people @linawolf, and she told me the right way to fix this will be to handle the :orphan: metadata in the guides, and tolerate missing title for documents with that metadata. Until that's done, we want to be able to get a green build.

@greg0ire greg0ire merged commit 1413b49 into doctrine:2.15.x Jul 11, 2023
@greg0ire greg0ire deleted the fix-build branch July 11, 2023 10:10
@greg0ire greg0ire added this to the 2.15.4 milestone Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants