spectrocloud / librarium

Palette/VerteX documentation
https://docs.spectrocloud.com
19 stars 36 forks source link

docs: partial fixes DOC-1263 #3253

Closed addetz closed 2 months ago

addetz commented 3 months ago

Describe the Change

This PR fixes the following bugs with the PartialsComponent:

Changed Pages

No user-facing changes.

Jira Tickets

🎫 DOC-1263

Backports

Can this PR be backported?

netlify[bot] commented 3 months ago

Deploy Preview for docs-spectrocloud ready!

Name Link
Latest commit c2cdb321a058b55f457bee72e99275b4e5b64f42
Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/668d90d8bccefc00085e83a1
Deploy Preview https://deploy-preview-3253--docs-spectrocloud.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

addetz commented 2 months ago

Nested partials testing steps

  1. Checkout the latest version of the feature branch.
    git checkout partial-fixes-doc-1263 && git pull
  2. Create a nested partial. For example, add folder _partials/nested and add a new mdx file with category example-cat-nested and name example-name-nested.
  3. Add the following snippet to any existing markdown page.
    <PartialsComponent category="example-cat-nested" name="example-name-nested" message="Hello Nested!" />
  4. Run make start. Navigate to the previously modified page and ensure that the example partial displays correctly with the following text:
    This is an example partial with an example property. Hello Nested!
  5. Open scripts/versions.sh and comment out L48-L54 & L124. This will stop pulling the latest changes on the version branch and enable us to run tests on versioning locally.
  6. Kill the local server. Commit the changes you've made to this branch with a temporary commit.
  7. Checkout any version branch
    git checkout version-4-3 && git pull
  8. Cherrypick the fix from the branch into the version branch.
    git cherry-pick 1760b631d4b980ba8f6605ff923c6dd6b29adad14
  9. Make any change to the nested partial you created previously.
    We are in version-4-3. This is an example partial with an example property. {props.message}
  10. Add the following snippet to any existing markdown page.
    <PartialsComponent category="example-cat-nested" name="example-name-nested" message="Hello from version 4.3.x!" />
  11. Commit the changes you've made to this branch with a temporary commit.
  12. Run make start. Navigate to the previously modified page and ensure that the example partial displays correctly with the following text:
    We are in version-4-3. This is an example partial with an example property. Hello!
  13. Kill the local server. Return to the feature branch
    git checkout partial-fixes-doc-1263
  14. Run make versions to create the versioned files.
  15. Run make start. Navigate to the pages modified in the feature branch and the version branch and ensure that the versioned partials text is displayed.
  16. Once you are done, clean versions and discard any temp commits in your branches
    make clean-versions
    git checkout version-4-3 && git reset origin/version-4-3 --hard
    git checkout partial-fixes-doc-1263 && git reset origin/partial-fixes-doc-1263 --hard
vault-token-factory-spectrocloud[bot] commented 2 months ago

💚 All backports created successfully

Status Branch Result
version-4-0
version-3-4
version-4-1
version-4-2
version-4-3
version-4-4

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details