Merge pull request #55 from veghdev/doc

doc: refactor, set doc versioning

Author: veghdev

.github/workflows/ci.yml

@@ -18,25 +18,36 @@ jobs:
 
     - uses: actions/cache@v3
       with:
-        path: ./.venv-ipyvizzu-story
-        key: venv-${{ inputs.run_id }}
+        path: ./.venv_ipyvizzu_story
+        key: venv-ipyvizzu-story-${{ inputs.run_id }}
+
+    - uses: actions/cache@v3
+      with:
+        path: ./node_modules
+        key: nodemodules-ipyvizzu-story-${{ github.run_id }}
 
     - uses: actions/cache@v3
       with:
         path: ./tests/coverage
-        key: coverage-${{ inputs.run_id }}
+        key: coverage-ipyvizzu-story-${{ inputs.run_id }}
 
     - name: Touch dev environment
       run: make touch-dev
+
+    - name: Touch dev-js environment
+      run: make touch-dev-js
 
     - name: Check format
       run: make check-format
 
-    - name: Run pylint
-      run: make lint
+    - name: Check lint
+      run: make check-lint
 
     - name: Check typing
       run: make check-typing
 
     - name: Run test
       run: make test
+
+    - name: Check js
+      run: make check-js

.github/workflows/cicd.yml

@@ -21,21 +21,15 @@ jobs:
     with:
       run_id: ${{ github.run_id }}
 
-  doc_build:
-    uses: ./.github/workflows/doc_build.yml
+  doc:
+    uses: ./.github/workflows/doc.yml
     needs: ci
     with:
       run_id: ${{ github.run_id }}
 
-  doc_publish:
-    uses: ./.github/workflows/doc_publish.yml
-    needs: doc_build
-    with:
-      run_id: ${{ github.run_id }}
-
   release:
     uses: ./.github/workflows/release.yml
     secrets: inherit
-    needs: doc_build
+    needs: doc
     with:
       run_id: ${{ github.run_id }}

.github/workflows/doc_build.yml renamed to .github/workflows/doc.yml

@@ -17,22 +17,25 @@ jobs:
 
       - uses: actions/cache@v3
         with:
-          path: ./.venv-ipyvizzu-story
-          key: venv-${{ inputs.run_id }}
+          path: ./.venv_ipyvizzu_story
+          key: venv-ipyvizzu-story-${{ inputs.run_id }}
 
       - uses: actions/cache@v3
         with:
-          path: ./tests/coverage
-          key: coverage-${{ inputs.run_id }}
+          path: ./node_modules
+          key: nodemodules-ipyvizzu-story-${{ github.run_id }}
 
       - uses: actions/cache@v3
         with:
-          path: ./site
-          key: site-${{ inputs.run_id }}
+          path: ./tests/coverage
+          key: coverage-ipyvizzu-story-${{ inputs.run_id }}
 
       - name: Touch dev environment
         run: make touch-dev
 
+      - name: Touch dev-js environment
+        run: make touch-dev-js
+
       - name: Set Jupyter kernel
         run: make install-kernel
 

.github/workflows/doc_publish.yml

@@ -18,8 +18,16 @@ jobs:
 
       - uses: actions/cache@v3
         with:
-          path: ./.venv-ipyvizzu-story
-          key: venv-${{ inputs.run_id }}
+          path: ./.venv_ipyvizzu_story
+          key: venv-ipyvizzu-story-${{ inputs.run_id }}
+
+      - uses: actions/cache@v3
+        with:
+          path: ./node_modules
+          key: nodemodules-ipyvizzu-story-${{ github.run_id }}
 
       - name: Init dev environment
-        run: make dev
+        run: make dev
+
+      - name: Init dev-js environment
+        run: make dev-js

.github/workflows/init.yml

@@ -18,17 +18,17 @@ jobs:
 
     - uses: actions/cache@v3
       with:
-        path: ./.venv-ipyvizzu-story
-        key: venv-${{ inputs.run_id }}
+        path: ./.venv_ipyvizzu_story
+        key: venv-ipyvizzu-story-${{ inputs.run_id }}
 
     - name: Touch dev environment
       run: make touch-dev
 
     - name: Build package
-      run: make release
+      run: make release-wo-restore
 
     - name: Release package
-      run: ./.venv-ipyvizzu-story/bin/python -m twine upload -u "__token__" -p "${{ secrets.PYPI_API_TOKEN }}" dist/*.tar.gz  dist/*.whl
+      run: ./.venv_ipyvizzu_story/bin/python -m twine upload -u "__token__" -p "${{ secrets.PYPI_API_TOKEN }}" dist/*.tar.gz  dist/*.whl
       if: ( github.event_name == 'release' && github.event.action == 'published' )
 
     - name: Upload package

.github/workflows/release.yml

@@ -7,12 +7,11 @@ build
 dist
 *.egg-info
 
-coverage
+tests/coverage
 .test.*
 
-.venv
-.venv-ipyvizzu-story
+.venv_ipyvizzu_story
 
 site
 node_modules
-package-lock.json
+package-lock.json

.github/workflows/site.yml

@@ -21,11 +21,11 @@ repos:
       types: [python]
       pass_filenames: false
 
-    - id: lint
+    - id: check-lint
       stages: [push]
-      name: lint
+      name: check-lint
       entry: make
-      args: ["lint"]
+      args: ["check-lint"]
       language: system
       types: [python]
       pass_filenames: false

.gitignore

@@ -17,7 +17,7 @@ detailed description of how to do this in
 
 ### Development environment
 
-You can initialize the development environment of ipyvizzu-story with python
+You can initialize the development environment of `ipyvizzu-story` with `Python`
 virtual env.
 
 Run the `dev` make target to set up your environment.
@@ -26,10 +26,6 @@ Run the `dev` make target to set up your environment.
 make dev
 ```
 
-**Note:** If you are using Windows, you need to install `GNU make` to use `make`
-commands. If you are using `Chocolatey`, you can easily install it with
-`choco install make`.
-
 **Note:** The `dev` make target is going to set up pre-commit and pre-push hooks
 into your local git repository. Pre-commit hook is going to format the code with
 `black` and pre-push hook is going to run the CI steps.
@@ -43,7 +39,7 @@ make clean
 ### CI
 
 The CI steps check code formatting, run code analyses, check typing and run unit
-tests over the ipyvizzu-story project.
+tests over the `ipyvizzu-story` project.
 
 The `check` make target collects the above tasks. Run the `check` make target to
 run the CI steps.
@@ -54,7 +50,7 @@ make check
 
 #### Formatting
 
-The ipyvizzu-story project is formatted with `black`.
+The `ipyvizzu-story` project is formatted with `black`.
 
 Run the `format` make target to format your code.
 
@@ -70,17 +66,17 @@ make check-format
 
 #### Code analyses
 
-The ipyvizzu-story project is analysed with `pylint`.
+The `ipyvizzu-story` project is analysed with `pylint`.
 
-Run the `lint` make target to run code analyses.
+Run the `check-lint` make target to run code analyses.
 
 ```sh
-make lint
+make check-lint
 ```
 
 #### Typing
 
-The ipyvizzu-story project is using type hints.
+The `ipyvizzu-story` project is using type hints.
 
 Run the `check-typing` make target to run check code typing.
 
@@ -90,9 +86,9 @@ make check-typing
 
 #### Testing
 
-The ipyvizzu-story project is tested with `unittest` testing framework.
+The `ipyvizzu-story` project is tested with `unittest` testing framework.
 
-Run the `test` make target to install ipyvizzu-story into your virtual
+Run the `test` make target to install `ipyvizzu-story` into your virtual
 environment and run the tests.
 
 ```sh
@@ -103,21 +99,27 @@ make test
 
 Run the `doc` make target to build the documentation.
 
+Note: If you modify the documentation, you also need to configure the
+`JavaScript` development environment.
+
 ```sh
+make dev-js
+
+make check-js
+
 make doc
 ```
 
-The documentation will be published to the gh-pages branch with the `doc`
-workflow. Online version can be read at
-[ipyvizzu-story.vizzuhq.com](https://ipyvizzu-story.vizzuhq.com).
+Online version can be read at
+[ipyvizzu-story.vizzuhq.com](https://ipyvizzu-story.vizzuhq.com/latest/).
 
 ### Release
 
-ipyvizzu-story is distributed on
+`ipyvizzu-story` is distributed on
 [pypi](https://pypi.org/project/ipyvizzu-story). **Note:** You need to be an
 administrator to release the project.
 
-If you want to release ipyvizzu-story follow the steps below.
+If you want to release `ipyvizzu-story` follow the steps below.
 
 - You should increase the version number in `setup.py`. The version bump should
   be in a separated commit.
@@ -126,7 +128,7 @@ If you want to release ipyvizzu-story follow the steps below.
   [Releases](https://github.com/vizzuhq/ipyvizzu-story/releases).
 
 **Note:** Publishing a new release will automatically trigger the `release`
-workflow which builds, checks and uploads the ipyvizzu-story package to
+workflow which builds, checks and uploads the `ipyvizzu-story` package to
 [pypi](https://pypi.org/project/ipyvizzu-story).
 
 You can build and check the package before a release with the `release` make