Skip to content

DOC Prepare for docs site #981

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

Merged

Conversation

emteknetnz
Copy link
Contributor

@emteknetnz emteknetnz commented Jul 16, 2025

Issue silverstripe/.github#420

This PR is preparation for adding Fluent to the "Optional Features" section on docs.silverstripe.org

This PR:

  • Adds an index.md page
  • Adds metadata to each page. The icons are fontawesome icons which can be seen here https://fontawesomeicons.com/
  • Chanages the file names so that they display in a predictable order, using our standard naming scheme. Let me know if the order of pages appears wrong and I'll change it.
  • Does some minor tidy up for standardisation with other docs e.g. uses - for bullet points rather than *

This PR will be used on the CMS 5 version of docs.silverstripe.org, and will be merged up to also be used on the CMS 6 version

@@ -67,7 +68,8 @@
"allow-plugins": {
"composer/installers": true,
"silverstripe/recipe-plugin": true,
"silverstripe/vendor-plugin": true
"silverstripe/vendor-plugin": true,
"dealerdirect/phpcodesniffer-composer-installer": true
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Required for composer to install correctly in CI with the new silverstripe/documentation-lint being added

@emteknetnz emteknetnz force-pushed the pulls/7.3/docs-site branch 5 times, most recently from 30cd87f to 9c802fe Compare July 17, 2025 04:58
@emteknetnz emteknetnz marked this pull request as ready for review July 17, 2025 05:07
@tractorcow
Copy link
Collaborator

Looks good to me. Nice work.

@tractorcow
Copy link
Collaborator

I remember the whole "numbering prefix" issue. I guess you're still using the same documentation generator? :P

@GuySartorelli
Copy link
Contributor

I remember the whole "numbering prefix" issue. I guess you're still using the same documentation generator? :P

Probably 😅 It's https://github.com/silverstripe/doc.silverstripe.org/ which uses gatsby.

Copy link
Contributor

@GuySartorelli GuySartorelli left a comment

Choose a reason for hiding this comment

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

I tried to catch all the **NOTE** and **IMPORTANT** style blocks that need to be turned into callout blocks, but I may have missed some. Can you please have a quick search for any I missed?

I probably also missed some code blocks that are missing use statements

@emteknetnz emteknetnz force-pushed the pulls/7.3/docs-site branch 2 times, most recently from 79bbba6 to 31c1584 Compare July 22, 2025 04:29
Copy link
Contributor

@GuySartorelli GuySartorelli left a comment

Choose a reason for hiding this comment

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

#981 (comment) still hasn't been responded to

@emteknetnz emteknetnz force-pushed the pulls/7.3/docs-site branch from 31c1584 to c25a010 Compare July 22, 2025 22:40
@emteknetnz
Copy link
Contributor Author

Have moved _manifest_exclude from docs/en to docs where it was originally

Copy link
Contributor

@GuySartorelli GuySartorelli left a comment

Choose a reason for hiding this comment

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

LGTM

@GuySartorelli GuySartorelli merged commit 88ffc5c into tractorcow-farm:7.3 Jul 22, 2025
11 checks passed
@GuySartorelli GuySartorelli deleted the pulls/7.3/docs-site branch July 22, 2025 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants