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

docs: partial fixes DOC-1263 #3253

Merged
merged 4 commits into from
Jul 9, 2024
Merged

docs: partial fixes DOC-1263 #3253

merged 4 commits into from
Jul 9, 2024

Conversation

addetz
Copy link
Contributor

@addetz addetz commented Jul 5, 2024

Describe the Change

This PR fixes the following bugs with the PartialsComponent:

  • Adjusts the partial generation script to work with nested folders.
  • Ignores partials for prettier formatting.
  • Fixes mistake with VersionedLink README.
  • Adds limitation of PartialsComponent around headings in the TOC.

Changed Pages

No user-facing changes.

Jira Tickets

🎫 DOC-1263

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

Copy link

netlify bot commented Jul 5, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit c2cdb32
🔍 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 addetz marked this pull request as ready for review July 5, 2024 14:39
@addetz addetz requested a review from a team as a code owner July 5, 2024 14:39
@addetz addetz added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 labels Jul 5, 2024
@addetz
Copy link
Contributor Author

addetz commented Jul 8, 2024

Nested partials testing steps

  1. Checkout the latest version of the feature branch.
git checkout partial-fixes-doc-1263 && git pull
  1. 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.
  2. Add the following snippet to any existing markdown page.
<PartialsComponent category="example-cat-nested" name="example-name-nested" message="Hello Nested!" />
  1. 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!
  1. 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.
  2. Kill the local server. Commit the changes you've made to this branch with a temporary commit.
  3. Checkout any version branch
git checkout version-4-3 && git pull
  1. Cherrypick the fix from the branch into the version branch.
git cherry-pick 1760b631d4b980ba8f6605ff923c6dd6b29adad14
  1. 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}
  1. 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!" />
  1. Commit the changes you've made to this branch with a temporary commit.
  2. 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!
  1. Kill the local server. Return to the feature branch
git checkout partial-fixes-doc-1263
  1. Run make versions to create the versioned files.
  2. 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.
  3. 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

@addetz addetz force-pushed the partial-fixes-doc-1263 branch 2 times, most recently from 9589f4b to 09e4b61 Compare July 8, 2024 19:43
@addetz addetz merged commit 709e018 into master Jul 9, 2024
17 checks passed
@addetz addetz deleted the partial-fixes-doc-1263 branch July 9, 2024 20:00
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)
@vault-token-factory-spectrocloud
Copy link
Contributor

💚 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

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 9, 2024
* docs: partial fixes DOC-1263

* docs: remove debug line DOC-1263

(cherry picked from commit 709e018)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants