chkware / chkware.github.io Goto Github PK

Blog items should have separate sub-site, with separate sub-menu

Blog articles topics:

• Release note
• Product update
• General
• HOW TOs
• Community update

Menu structure:

|  - YYYY-MM
    |  - Aricle-One

Create a CI/CD pipeline for automatic deploying to Github Pages whenever a new change is made in main branch.

• Add separate page for variables
• Give example on http examples seciton to show how to use

Update the deploy workflow file so that the new custom GitHub Actions workflow can be used.

https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow

The benefit is that

• we can use GitHub's official workflow rather than relying on 3rd party package.
• The build time will be slightly lesser.
• Easier custom domain implementation.

On my windows machine I tried with as given on README. But it failed with following image.

Platform windows 10
Node 16.14.1

I will also try on Linux and update here

• How to setup local env for development
• How to setup local env for test
• How and where to create questions and issues

• #7
• #16
• #9

• quick start should be one page
• but should contain different examples to get started

• Use chkware logo / favicon instead of docusaurus logo
• Disable blog
• Disable Tutorial - Extras
• Rename Tutorial - Basics to More Examples
• Migrate existing pages to website
• Add following in footer
  • Issues
    • Github issues - should open https://github.com/chkware/cli/issues on new browser tab
  • Community
    • Question - should open https://stackoverflow.com/questions/tagged/chkware-cli on new browser tab
    • Discussion - should open a slack URL on new browser tab [not ready]
  • Follow us
    • Chkware @ twitter - should open https://twitter.com/chkware on new browser tab
    • Chkware @ github - should open https://github.com/chkware/cli on new browser tab
    • Chkware @ pypi - should open https://pypi.org/project/chk/ on new browser tab

Docusaurus 2.x just released. Let's migrate our website to 2.x to be forward compatible.

• purpose of version string
• available version string
• How to check supported version string locally
• Add return docs for http spec

• variables documentation

https://github.com/chkware/HEAD/blob/399baa04233d9a25f127a79724ca787a81d5180d/plan_docs/api-test-assertions.md

Create a CI/CD for testing the deployment on every pull request/before merging to main branch so that issues like #19 can be avoided.

Add linting and prettier support to this project so that future contributions will follow the same coding style and format.

Syntax highlighting support for yaml & http

something like https://highlightjs.org/

• add a use-case section. this shows possibility of chk command use case
• add use case for request, with output control, and basic parsing with bash
• add use case for testcase

• reference
• tutorial

Copying the command inserts this $ sign which may be invalid for different platform users.

We are using many URL here and there, whenever we have to change a link in the link tree, we also need to find all the links used in all the docs, and modify according to the URL updated.

[name](url)

Solution we need a way to tag a link by URL, and reuse it everywhere; so when link tree updates then we just change in one place to see reflection everywhere.

• to keep the commit message style consistent
• to keep the coding style consistent

• that combines both http and testcases
• advance testcases with separate http file

• reference
• example
• #45
• update home page to add an assert example
• add quick start for assert (may be update same page?!)

This doc do not have a general progression for new users.

since it's removed by chkware/cli#65

• setup for chkware tool locally for users
• setup for chkware repo for local development

• contribution guide for chkware/cli
• contribution guide for chkware/vscode-ext

• reference
• tutorial