fix merge conflict

This commit is contained in:
Deborah Barnard
2023-02-02 15:01:04 +00:00
6 changed files with 38 additions and 33 deletions

3
.gitmodules vendored Normal file
View File

@@ -0,0 +1,3 @@
[submodule "_submodules/insiders"]
path = _submodules/insiders
url = git@github.com:n8n-io/mkdocs-material-insiders.git

View File

@@ -10,30 +10,39 @@ This repository hosts the documentation for [n8n](https://n8n.io/), an extendabl
### Prerequisites
* Python 3.8 or above
* Pip
* We recommend using a virtual environment when working with Python, such as [venv](https://docs.python.org/3/tutorial/venv.html).
* Follow the [recommended configuration and auto-complete](https://squidfunk.github.io/mkdocs-material/creating-your-site/#minimal-configuration) guidance for the theme. This will help when working with the `mkdocs.yml` file.
### Steps
```bash
#### For members of the n8n GitHub organization:
1. Set up an SSH token and add it to your GitHub account. Refer to [GitHub | About SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) for guidance.
2. Then run these commands:
```bash
git clone --recurse-submodules git@github.com:n8n-io/n8n-docs.git
cd n8n-docs
pip install -r requirements.txt
pip install _submodules/insiders
```
#### For external contributors:
Rely on the preview builds on pull requests, or use the free version of Material for MkDocs (most things are the same, some formatting may be missing)
```
git clone https://github.com/n8n-io/n8n-docs.git
cd n8n-docs
pip install -r requirements.txt
# n8n organization members:
# Outside your docs project, do:
git clone https://github.com/n8n-io/mkdocs-material-insiders.git mkdocs-material
# Navigate back into the docs project and run:
pip install -e <path-to-mkdocs-material>
# External contributors: rely on the preview builds on pull requests, or
# use the free version of Material for MkDocs (most things are the same, some formatting may be missing)
pip install mkdocs-material
```
# Serve a local preview
#### To serve a local preview:
```
mkdocs serve
# Or build
mkdocs build
```
## Contributing

1
_submodules/insiders Submodule

Submodule _submodules/insiders added at fa82852781

View File

@@ -4,24 +4,18 @@ If you have already installed Docker and Docker-Compose, then you can start with
### 1. Install Docker
This can vary depending on the Linux distribution used. The below example is for Ubuntu:
This can vary depending on the Linux distribution used. You can find detailed instructions in the [Docker documentation](https://docs.docker.com/engine/install/){:target=_blank .external-link}. The following example is for Ubuntu:
```bash
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common -y
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo apt-get remove docker docker-engine docker.io containerd runc
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg lsb-release
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
# Depending on Version:
# Ubuntu 18.04:
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"
# Ubuntu 20.04
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"
sudo apt update
sudo apt upgrade -y
sudo apt install docker-ce -y
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io
```
### 2. Optional: Non-root user access
@@ -35,13 +29,12 @@ su - ${USER}
### 3. Install Docker-Compose
This can vary depending on the Linux distribution used. Before proceeding check the latest version of Docker Compose v1 [on the repository's release page](https://github.com/docker/compose/releases) and replace the `1.29.2` below. Should you wish to use Docker Compose v2 instead you can find detailed instructions [here in the Docker documentation](https://docs.docker.com/compose/cli-command/).
This can vary depending on the Linux distribution used. You can find detailed instructions in the [Docker documentation](https://docs.docker.com/compose/){:target=_blank .external-link}.
The example below is for Ubuntu:
```bash
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo apt-get install docker-compose-plugin
```
### 4. DNS setup

View File

@@ -1,3 +1,3 @@
[build]
command = "pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.0.5-insiders-4.28.1 && mkdocs build"
command = "pip install _submodules/insiders && mkdocs build"
publish = "site"

View File

@@ -1,3 +1,2 @@
mkdocs-literate-nav==0.4.1
mkdocs-macros-plugin==0.7.0
neoteroi-mkdocs==0.0.5