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.

Sign up for GitHub

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

Jump to bottom

Updated code reference tags in testrunner config doc #40

Merged
merged 5 commits into from
Dec 10, 2020
Merged

Updated code reference tags in testrunner config doc #40

merged 5 commits into from
Dec 10, 2020

Conversation

Tacktician
Copy link
Contributor

Updated code reference tags in testrunner config doc.

Description

Updated reference tags in docs/testrunner-toolkit/configuration.md to use theme-github-codeblock theme plugin.

Motivation and Context

To expermint with the github-codeblock reference plugin

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation fix (typos, incorrect content, missing content, etc.)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@Tacktician Tacktician added the enhancement New feature or request label Nov 19, 2020
@Tacktician
Copy link
Contributor Author

@christian-bromann looks like there was a SSR-related error when I tried to push the changes with the Github plugin through CI.

I did some digging and these two Docusaurus issues looked promising:

@christian-bromann
Copy link
Contributor

@spider-sauce it seems to be related to the borales/actions-yarn action you are using. If I try to install everything with NPM as well as locally with yarn it works fine.

@Tacktician
Copy link
Contributor Author

@spider-sauce it seems to be related to the borales/actions-yarn action you are using. If I try to install everything with NPM as well as locally with yarn it works fine.

@christian-bromann you're correct. I believe it's because borales/actions-yarn uses yarn 2.x, which Docusaurus doesn't explicitly recommend. So I switched the cache reference and install/build actions to use npm. 🤞

@Tacktician Tacktician merged commit 9ad8bf0 into master Dec 10, 2020
@christian-bromann christian-bromann deleted the feat/theme-github-codeblock branch December 11, 2020 08:23
kmissoumi pushed a commit to kmissoumi/sauce-docs that referenced this pull request Nov 3, 2021
@Tacktician
Updated code reference tags in testrunner config doc (saucelabs#40)
71c4802 
* updated reference tags in testrunner-toolkit/configuration.md

* updated reference tags

* updated deploy.yml to include `npm` commands instead of `yarn`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christian-bromann christian-bromann Awaiting requested review from christian-bromann

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Tacktician @christian-bromann