[v17] Edit docs CI workflows to accommodate Docusaurus #50550
Merged
Conversation
This file contains 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
ptgott
added
the
no-changelog
ptgott
requested review from
klizhentas,
russjones,
r0mant,
zmb3,
fheinecke,
camscale,
tcsc,
rosstimothy and
codingllama
as code owners
ptgott
force-pushed
the
paul.gottschling/48388-bp-v17
branch
2 times, most recently
from
c9e7e1d to
333b190
Compare
zmb3
approved these changes
Dec 26, 2024
ptgott
force-pushed
the
paul.gottschling/48388-bp-v17
branch
from
333b190 to
d58e1db
Compare
Backports #48388 * Edit docs CI workflows to accommodate Docusaurus - Copy the `gravitational/teleport` source into the `content` directory of a `gravitational/docs-website` clone and overwrite the `git-update` yarn script with a no-op command. With way, we can use the `gravitational/teleport` clone across multiple workflow steps (e.g., the prose linting step), and can identify a branch to pull using the `actions/checkout` defaults. Name the submodule directory `current` to match the expectations of the Docusaurus site. - Remove the Vercel preview workflow. After the docs engine migration, we'll no longer need to deploy a preview to Vercel in order to show docs authors what their potential changes look like on a rendered docs site. Also fixes spelling errors caught by a later version of cspell. * Fix shellcheck issues in doc-tests.yaml script - Add `exit` commands for failed `cd`s - Don't read from and write to `package.json` in the same pipeline - Add double quotes around variables * Use latest Docusaurus site config schema * Fix the Prepare docs site configuration step - Remove unneeded `cd`s - Use the correct version name in the `config.json` prepared for the Docusaurus site
ptgott
force-pushed
the
paul.gottschling/48388-bp-v17
branch
from
d58e1db to
adcefc7
Compare
|
Amplify deployment status
|
mmcallister
approved these changes
Jan 3, 2025
public-teleport-github-review-bot
bot
removed the request for review
from taraspos
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Backports #48388
Copy the
gravitational/teleportsource into thecontentdirectory of agravitational/docs-websiteclone and overwrite thegit-updateyarn script with a no-op command. With way, we can use thegravitational/teleportclone across multiple workflow steps (e.g., the prose linting step), and can identify a branch to pull using theactions/checkoutdefaults. Name the submodule directorycurrentto match the expectations of the Docusaurus site.Remove the Vercel preview workflow. After the docs engine migration, we'll no longer need to deploy a preview to Vercel in order to show docs authors what their potential changes look like on a rendered docs site.
Also fixes spelling errors caught by a later version of cspell.
exitcommands for failedcdspackage.jsonin the same pipelineUse latest Docusaurus site config schema
Fix the Prepare docs site configuration step
cdsconfig.jsonprepared for the Docusaurus site