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

Add docs automation workflow #148

Open
mlycore opened this issue Jun 28, 2022 · 6 comments
Open

Add docs automation workflow #148

mlycore opened this issue Jun 28, 2022 · 6 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed type:enhancement New feature or request

Comments

@mlycore
Copy link
Member

mlycore commented Jun 28, 2022

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 mlycore added type:enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jun 28, 2022
@strongduanmu
Copy link

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

@xuanyuan300
Copy link
Contributor

@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.

@strongduanmu
Copy link

@xuanyuan300 Ok, thank you for your remind.

@xuanyuan300
Copy link
Contributor

xuanyuan300 commented Jul 4, 2022

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.

@strongduanmu
Copy link

@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. 😂

@mlycore
Copy link
Member Author

mlycore commented Jul 11, 2022

@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 mlycore assigned mlycore and unassigned strongduanmu Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed type:enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants