Docs update and spellchecking #156
Conversation
|
Question is whether to use the same spellcheck for github action and for pre-commit. There is only one issue as it has external dependencies - it uses aspell or hunspell engines with dictionaries for spellcheck. There is no support in pre-commit for pyspelling tool, there are other spell checkers ( |
| @@ -54,6 +54,17 @@ Change directory to the project generated in /home/mario/kedro/kubeflow-plugin-d | |||
| A best-practice setup includes initialising git and creating a virtual environment before running `kedro install` to install project-specific dependencies. Refer to the Kedro documentation: https://kedro.readthedocs.io/ | |||
| ``` | |||
|
|
|||
| There are some adjustments that need to be made to run starter Kedro project on Kubeflow. We need to replace all dots in names of catalog with other characters as Kubeflow does not accept dots in names. You can do it by using `sed` in starter root directory: | |||
There was a problem hiding this comment.
This is not true, currently end 2 end tests are passing with catalog entries having dots. What I would mention instead is that the plugin was not yet adjusted to work with kedro namespaces so using them may cause issues.
The problem with namespaces and dots happens when we're using mounted volume and save artifacts as kubeflow outputs
There was a problem hiding this comment.
Yeah, maybe the wording needs to be improved? By default the basic example does use kubeflow outputs, so the problem occurs. In e2e we swapped catalog file config from starter to use other types of storage such as gcp bucket.
| @@ -54,6 +54,17 @@ Change directory to the project generated in /home/mario/kedro/kubeflow-plugin-d | |||
| A best-practice setup includes initialising git and creating a virtual environment before running `kedro install` to install project-specific dependencies. Refer to the Kedro documentation: https://kedro.readthedocs.io/ | |||
| ``` | |||
|
|
|||
| There are some adjustments that need to be made to run starter Kedro project on Kubeflow. We need to replace all dots in names of catalog with other characters as Kubeflow does not accept dots in names. You can do it by using `sed` in starter root directory: | |||
There was a problem hiding this comment.
Yeah, maybe the wording needs to be improved? By default the basic example does use kubeflow outputs, so the problem occurs. In e2e we swapped catalog file config from starter to use other types of storage such as gcp bucket.
Lasica
changed the title
The new image uses the same tool and is more actively maintained
Recommonmark is no longer supported and points to myst as replacement: https://recommonmark.readthedocs.io/en/latest/
… setup Moved local testing as enriched text admonitions to guide with tips about local cluster testing.
As per @mwiewior's suggestion to limit the runs
|
Now also resolves #162 |
It enables the feature of using variables in documentation. Resolves #136
Spellcheck now also enabled for README and CONTRIBUTING. Fixed spelling mistakes
For code fences a workaround needs to be done, as jinja is ignored inside code fences
This was overlooked in previous solution.
Also fixed issue with wildcard path finding
Description
Updating the documentation with extra info about difficulties during the setup with starter kedro and about contributing/local testing. Also adds spellcheck github action,
Resolves #155
Resolves #162
Resolves #119
Resolves #132
PR Checklist