pisanix icon indicating copy to clipboard operation
pisanix copied to clipboard

Add docs automation workflow

Open mlycore opened this issue 2 years ago • 6 comments

Development Task

For better documentation, there is a need for docs automation workflow. Trying to build a Github Action to implementing the following steps:

  1. Run npm run build under docs
  2. Copy all generated files under docs/build to cloned pisanix.io
  3. Push the changes of pisanix.io to its branch gh-pages

mlycore avatar Jun 28 '22 17:06 mlycore

@mlycore Can you assign this issue to me, I want to try.

strongduanmu avatar Jun 29 '22 08:06 strongduanmu

@mlycore Can you assign this issue to me, I want to try.

Hi @strongduanmu, Thanks a lot. Since the release v0.1.1, the docs has changed to the versioned docs, I will add some steps for generate versioned docs.

xuanyuan300 avatar Jun 29 '22 08:06 xuanyuan300

@xuanyuan300 Ok, thank you for your remind.

strongduanmu avatar Jun 29 '22 09:06 strongduanmu

Prepare step: cd docs

  1. Run npm i to install dependencies.
  2. Run npm docusaurus docs:version x.x.x. When tagging a new version, the document versioning mechanism will:
  • Copy the full docs/ folder contents into a new versioned_docs/version-[versionName]/ folder.
  • Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-[versionName]-sidebars.json.
  • Append the new version number to versions.json. Please see https://docusaurus.io/docs/versioning
  1. Run npm run build.
  2. Copy all generated files to cloned pisanix.io.
  3. Push the changes of pisanix.io to its branch gh-pages.

xuanyuan300 avatar Jul 04 '22 02:07 xuanyuan300

@mlycore @wbtlb @xuanyuan300 I'm so sorry to everyone, because I've been very busy recently, this issue can't be completed in time. If there is a dead time for this task, I think it can be done by other friends. 😂

strongduanmu avatar Jul 10 '22 01:07 strongduanmu

@mlycore @wbtlb @xuanyuan300 I'm so sorry to everyone, because I've been very busy recently, this issue can't be completed in time. If there is a dead time for this task, I think it can be done by other friends. 😂

Dont worry, I'll reassign it.

mlycore avatar Jul 11 '22 00:07 mlycore