Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[docs] document new config values #1562

Merged
merged 12 commits into from
Aug 29, 2024
Merged

Conversation

jrushlow
Copy link
Collaborator

@jrushlow jrushlow commented May 16, 2024


Yup - totally stole the code from https://github.com/symfony/symfony-docs/tree/7.1/_build to preview the build

Open to ideas on how we can preview the docs that ultimately get published on symfony.com without doing the whole "make change -> merge PR" rinse and repeat cycle...

@jrushlow jrushlow added the Minor Minor Enhancement label May 16, 2024
@jrushlow jrushlow added this to the v1.60.0 milestone May 16, 2024
@jrushlow jrushlow force-pushed the minor/docs-update branch from 8686e12 to 7089e15 Compare May 16, 2024 13:15
@jrushlow jrushlow added the Status: Needs Review Needs to be reviewed label May 16, 2024
@jrushlow jrushlow modified the milestones: v1.60.0, v1.61.0 Jun 10, 2024
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

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

I think this is correct. Thanks Jesse!

If we assume that the doc of this bundle will always be a single page (which I think it's safe to assume) then you could simplify some things if you want:

  • You could remove the disable-cache option because when having 1 doc page, it doesn't make any noticeable difference
  • All the logic related to this --> "fix assets URLs to make them absolute (otherwise, they don't work in subdirectories)" could be removed because you don't have images and, if you include images in the future, you won't have subdirectories for contents because all the docs are in a single page

A final comment: something very useful for us is to run a RST linter to docs. It detects so many issues! We use DOCtor-RST (created by @OskarStark and actively developed by folks like @alamirault). We use it like this:

https://github.com/symfony/symfony-docs/blob/9bfc9fad274711f88b77364b7d36a7db86c79f7f/.github/workflows/ci.yaml#L53-L78

@jrushlow jrushlow merged commit a64783e into symfony:main Aug 29, 2024
8 of 9 checks passed
@jrushlow jrushlow deleted the minor/docs-update branch August 29, 2024 16:21
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Minor Minor Enhancement Related Tests Pass Status: Needs Review Needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants