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

Refactor documentation includes to align with main documentation pattern #6495

Merged
merged 2 commits into from
Nov 21, 2024
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
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
"spelling_wordlist.txt",
"contributing/branch-policy.md",
"_inc/*",
]

suppress_warnings = [
Expand Down
12 changes: 6 additions & 6 deletions docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Volto has the following folder structure.

To set up a Volto core development environment, your system must satisfy the following prerequisites.

```{include} ./install-operating-system.md
```{include} ../_inc/_install-operating-system.md
```

- {term}`nvm`
Expand All @@ -94,7 +94,7 @@ When developing a project using Plone, Yarn or other package managers may be use

### nvm

```{include} ./install-nvm.md
```{include} ../_inc/_install-nvm.md
```


Expand All @@ -103,7 +103,7 @@ When developing a project using Plone, Yarn or other package managers may be use
We recommend that you install Node.js using nvm.
Alternatively you can install Node.js using Homebrew or other package installer.

```{include} ./install-nodejs.md
```{include} ../_inc/_install-nodejs.md
```


Expand Down Expand Up @@ -136,19 +136,19 @@ Compare the output to the [latest pnpm release number](https://www.npmjs.com/pac

### Make

```{include} ./install-make.md
```{include} ../_inc/_install-make.md
```


### Docker

```{include} ./install-docker.md
```{include} ../_inc/_install-docker.md
```


### Git

```{include} ../contributing/install-git.md
```{include} ../_inc/_install-git.md
```


Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The Volto Team reviews pull requests only from people with a GitHub account who

## Branch policy

```{include} ./branch-policy.md
```{include} ../_inc/_branch-policy.md
```


Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/version-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ We do not guarantee that outdated browsers, such as Internet Explorer 11, are su

## Branch policy

```{include} ./branch-policy.md
```{include} ../_inc/_branch-policy.md
```


Expand Down
1 change: 1 addition & 0 deletions packages/volto/news/6495.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Refactor documentation includes to align with main documentation pattern. @stevepiercy
Loading