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

Update CONTRIBUTING.md #553

Merged
merged 7 commits into from
Sep 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion open-machine-learning-jupyter-book/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,4 +290,36 @@ jupyter notebook

> **Warning**
>
> Please make sure the Jupyter Notebook is running in trusted mode, and the [init_cell](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/init_cell/README.html) is configured for the first cell of slide notebook. So that the first cell will be automatically executed to load the CSS.
> Please make sure the Jupyter Notebook is running in trusted mode, and the [init_cell](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/init_cell/README.html) is configured for the first cell of slide notebook. So that the first cell will be automatically executed to load the CSS.
>

## FAQ

**Regarding the deletion and addition of the _toc.yml file:**

```bash
* The _toc file is located in the open-machine-learning-jupyter-book [directory](https://github.com/ocademy-ai/machine-learning/blob/main/open-machine-learning-jupyter-book/_toc.yml)
* In Jupyter Book, the _toc.yml file is the file used to define the directory structure of the book, containing the book chapters, sub-chapters and page hierarchy.
* When you build your book using Jupyter Book, it reads the _toc.yml file and generates a navigation bar based on the directory structure in it.
* To speed up the local book build, you can keep only the content of the chapters you changed for the build. This speeds up the build and ignores errors reported by other chapters.
* However, when deleting other chapters, pay attention to ensure the integrity of the entire book structure, otherwise it may lead to error reporting, it is recommended that when you first get started, one by one CAPTION deletion.
* After the preview, please restore the original _toc structure
```

**Non-consecutive header level increase**

You may see below failures when building the books:

```bash
WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
```

This error is caused by the presence of a non-consecutive heading level increase in the specified Jupyter notebook file. Specifically, the heading level increases directly from 0 to 2 without going through level 1.
To resolve this issue, you can follow these steps:
```bash
1. Open the specified Jupyter notebook file.
2. Check the setting for the heading level, which in this lesson is the number of '#'.
3. Ensure that the heading level increases continuously without skipping any levels.
4. If you find a non-continuous heading level increase, adjust it to a continuous level increase.
5. Save the file and re-run the code to ensure the error has been resolved.
```
2 changes: 1 addition & 1 deletion open-machine-learning-jupyter-book/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Note that we may need to set the `width` to `105%` so that all content of `index

4\. Embed HTML within the corresponding section. HTML embedding method refer to Python. For example:

```text
```python
from IPython.display import HTML
display(HTML("""
<p style="text-align: center;">
Expand Down
Loading