diff --git a/.github/workflows/Pull_Request.yml b/.github/workflows/Pull_Request.yml index 67b2aae..c0ec631 100644 --- a/.github/workflows/Pull_Request.yml +++ b/.github/workflows/Pull_Request.yml @@ -1,25 +1,22 @@ name: LitmusDocs-CI on: pull_request: - types: [ opened, synchronize, reopened ] + types: [opened, synchronize, reopened] paths: - - '.github/workflows/dockerbuild.yml' - - '.github/workflows/Pull_Request.yml' - - 'website/**' + - "website/**" jobs: embedmdCheck_and_linksVerification: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 with: - ref: ${{steps.getcommit.outputs.sha}} + ref: ${{steps.getcommit.outputs.sha}} - uses: actions/setup-go@v2 with: - stable: 'false' - go-version: '1.14.0' + stable: "false" + go-version: "1.14.0" - name: Links Verification run: | @@ -32,10 +29,10 @@ jobs: go get github.com/campoy/embedmd cd website/docs embedmd -w $(find *.md) - continue-on-error: true - + continue-on-error: true + - name: embedmd check - run: | + run: | export TERM=xterm-256color count=$(git status -s| wc -l) if [ "$count" -ne "0" ] @@ -53,7 +50,7 @@ jobs: tput setaf 2; echo "Nothing to embed" fi shell: sh - + ci: runs-on: ubuntu-18.04 steps: @@ -65,11 +62,10 @@ jobs: Spellcheck: runs-on: ubuntu-latest steps: - # The checkout step - - uses: actions/checkout@master - - uses: rojopolis/spellcheck-github-actions@0.11.0 - name: Spellcheck - with: - source_files: 'website/docs/*.md' - task_name: Markdown - \ No newline at end of file + # The checkout step + - uses: actions/checkout@master + - uses: rojopolis/spellcheck-github-actions@0.11.0 + name: Spellcheck + with: + source_files: "website/docs/*.md" + task_name: Markdown diff --git a/.github/workflows/docker_Push.yml b/.github/workflows/docker_Push.yml index b8a7ae9..09c37fb 100644 --- a/.github/workflows/docker_Push.yml +++ b/.github/workflows/docker_Push.yml @@ -5,9 +5,7 @@ on: branches: - master paths: - - '.github/workflows/dockerbuild.yml' - - '.github/workflows/Pull_Request.yml' - - 'website/**' + - "website/**" jobs: cd: @@ -26,5 +24,24 @@ jobs: run: | docker build -t ${GITHUB_REPOSITORY}:${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }} . docker push ${GITHUB_REPOSITORY}:${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }} - + netlify-deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Use Node.js 12.x + uses: actions/setup-node@v1 + with: + node-version: 12.x + # Run npm install and build on our code + - run: | + cd website + npm install + npm run build + # Deploy to Netlify using our production secrets + - uses: netlify/actions/cli@master + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} + with: + args: deploy --dir=website/build --prod diff --git a/.wordlist.txt b/.wordlist.txt index 6591536..1c048c7 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -693,6 +693,12 @@ ZTN html XXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXX +Worklfow +LitmusPortal +abc +litmusctl +subcommand +Litmusctl gz zxvf MacOS @@ -712,4 +718,4 @@ CertManager installCRDs jetstack ClusterMode -LetsEncrypt \ No newline at end of file +LetsEncrypt diff --git a/README.md b/README.md index 56cec52..f8f71ca 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,11 @@ Additional details on the Docusaurus project can be found [here](https://docusau ## For Developers -### Clone litmus-docs repository +### Clone litmus-docs-beta repository ```bash -git clone https://github.com/litmuschaos/litmus-docs.git -cd litmus-docs +git clone https://github.com/litmuschaos/litmus-docs-beta.git +cd litmus-docs-beta ``` The docs website server can be setup manually or through docker compose diff --git a/website/docs/agent-installation.md b/website/docs/agent-installation.md index 1068a39..870ffff 100644 --- a/website/docs/agent-installation.md +++ b/website/docs/agent-installation.md @@ -13,7 +13,6 @@ As part of Litmus installation by default, a self cluster would be registered as As you are aware by now, Portal is a Cross Cloud Chaos Control plane. That is you can connect multiple external kubernetes agents to this portal. Once connected you can manage the chaos from the Portal that is you can induce chaos into this agent from the Portal and observe the results from the Portal. Using the command line utility _litmusctl_ you can connect the external agents to the Portal. - # Litmusctl Litmusctl is a command line interface to manage LitmusPortal services.