Update Docker PHP Docs for Docker PHP 4.0 #579
Draft
+8,244
−12,179
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danpastori
added
the
📝 Documentation
Deploying serversideup-php with
|
| Latest commit: |
d3f8bfe
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://18530734.serversideup-php.pages.dev |
| Branch Preview URL: | https://feature-280-pr-docs-update.serversideup-php.pages.dev |
…EADME for clarity. Refactor app components and CSS for improved styling and structure.
…docs-update # Conflicts: # docs/content/1.getting-started/3.installation.md
…docker-php into feature/280-pr-docs-update
…FPM-NGINX, and FrankenPHP variations. Marked NGINX Unit as deprecated and provided migration guidance. Improved overall structure for better user understanding.
… links to reflect Server Side Up resources.
… and update the icon for better clarity.
…in YAML frontmatter.
…documentation pages to streamline content presentation.
…reflect Server Side Up branding.
…Images branding and SEO metadata
…se of Nuxt UI and providing a link to the Nuxt UI Documentation Template.
…n essential information.
… clarity, removing outdated sections and adding a callout for Docker compatibility.
… "batteries included" approach for improved developer experience.
…and focus on core topics.
…ing icon, title, and description
…ation for PHP Docker images, enhancing clarity and consistency.
…HP variation' for improved accuracy in PHP Docker images comparison.
…d eliminate unused resources.
…ining PHP Docker images
…es, project context, writing standards, and best practices for contributing to PHP Docker images.
…display in the application.
… and clarity in PHP Docker images.
…epresentation of Docker layers in PHP images.
…or PHP Docker images. Updated content for clarity, added new sections on containerization benefits, and included quick start instructions. Added images for better visual representation of running PHP containers and PHP info.
…to enhance documentation clarity and visual consistency.
…ditional languages, enhancing readability and developer experience.
…' in the community section, improving resource accessibility for users.
…ng Docker-related file icons for improved visual consistency in documentation.
…definition, improved project setup instructions, and included new images showcasing PHP version changes and settings. Enhanced clarity on configuring PHP settings in Docker Compose.
…overview, clarified benefits, and added call-to-action buttons for installation and advantages.
… to enhance clarity on changing PHP versions and variations.
…definition for 'Volume', correcting minor wording for clarity, and improving descriptions of PHP version display in the browser. This update aims to provide clearer guidance for users.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A Complete Overhaul of the documentation
This PR updates the documentation to use the latest and greatest Nuxt along with Nuxt UI for standardized development. Included in this PR:
Remaining Items
Homepage
Layout
Nest the documentation under
/docs/docsSEO
Documentation
Most of the documentation needs to be migrated. I didn't do all of this because it's going to be heavily updated. Here are some of the documentation migration notes:
Updated Front Matter
The front matter is the YAML that is on the markdown pages. The new format is:
The big difference is we have icons before the documentation. You can find all icons here: https://lucide.dev/icons/. To add the icon it's
i-lucide-{name found on site}. The docs does use Iconify so there could be other providers as well. Lucide fits really nice with the docs though.Migrating Code Embeds
@jaydrogers The biggest thing you will have to update in the documentation is the code embeds. We are using: https://ui.nuxt.com/docs/typography/code#filename. There's also code group: https://ui.nuxt.com/docs/typography/code-group
What you will have to do is remove all
::code-panelcomponents within the docs and update to the new format. There is nolabelso you will have to use anh3tag to label if needed. The new format allows you to set filename though. For an example, check out/docs/content/1.getting-started/3.installation.md. I have an example in there.LLM Data
@jaydrogers We will need to fill out the LLM Data for the docs: https://nuxt.com/modules/llms. This is a new feature that allows you to help LLMs find what they need in your documentation.
It'd also be helpful to provide some sample LLM documentation: https://reka-ui.com/docs/overview/getting-started#example-prompts