Skip to content

Commit 913be14

Browse files
committed
Address PR feedback
1 parent 2f7ed14 commit 913be14

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

doc/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,15 @@ install (`pip install -e`, as described in [main
6262
contributing notes](../CONTRIBUTING.md)), so that you only need to restart
6363
the Jupyter kernel when you have changed the source code of the feature.
6464

65-
### Branches
65+
### Branching strategy
6666

67-
Two different cases exist, whether you are documenting a feature already
68-
released, or which has just been included but not yet released.
67+
- The `doc-prod` branch contains the live docs which are available on the website. As soon as a change is merged into `doc-prod`, the updated docs are deployed and made publicly available.
68+
- The `main` branch contains docs which have been written but are not ready to be released, such as for an upcoming feature in the next plotly.py release.
6969

70-
- Case of an already released feature: your changes can be deployed to the
71-
documentation website as soon as they have been merged, and you should start
72-
your branch off the `doc-prod` branch and open your pull request against this
73-
`doc-prod` branch.
74-
- Case of a new (not released yet) feature: start your branch / pull request
75-
against the `main` branch. `main` and `doc-prod` will be synchronized at
76-
release time, so that the documentation of the feature is only deployed when
77-
it is available in a released version of `plotly.py`.
70+
When updating the docs, two workflows are possible:
71+
72+
- In the case of updating the docs for an already-released feature: your changes can be deployed to the documentation website as soon as they have been merged, so you should branch off of the `doc-prod` branch and open your pull request into the `doc-prod` branch.
73+
- In the case of writing docs for a new (not-yet-released) feature: you should branch off `main` and open your pull request into `main`, so that the documentation of the feature is only deployed when it is available in a released version of `plotly.py`. The `main` branch will be merged into `doc-prod` at release time, as described below.
7874

7975
#### Keeping `main` and `doc-prod` in sync
8076

@@ -98,7 +94,7 @@ At release time the synchronization is bidirectional (see also
9894
section of `RELEASE.md` for the full procedure.
9995

10096
> **Release prep:** When synchronizing `main` into `doc-prod` for a new
101-
> release, update the `plotly==` version pin in `requirements.txt` to match
97+
> release, update the `plotly==` version pin in `doc/requirements.txt` to match
10298
> the newly released version. The `doc-prod` build uses this pinned version
10399
> (not an editable install), so examples that rely on new features will fail
104100
> if the pin is stale.
@@ -148,7 +144,7 @@ jupyter:
148144
---
149145
```
150146

151-
The `plotly` metadata fields are the most important to get right:
147+
The `plotly` metadata fields are the most important to enter correctly when creating/updating a tutorial:
152148

153149
| Field | Description |
154150
|-------|-------------|
@@ -335,7 +331,7 @@ defined in `.github/workflows/build-doc.yml`.
335331

336332
| Event | What happens |
337333
|-------|-------------|
338-
| Pull request (any branch) | Tutorials are built and validated. The build artifact is uploaded but not deployed. |
334+
| Pull request (any branch) | Tutorials (markdown files in doc/python) are built and validated. The build artifact is uploaded but not deployed. |
339335
| Push to `doc-prod` | Full build: tutorials are built, validated, and deployed. API docs are also built and deployed. |
340336

341337
### Build steps

0 commit comments

Comments
 (0)