/docs.wordops.net

WordOps documentation built with Mkdocs

MIT LicenseMIT

WordOps Documentation

WordOps documentation sources files are stored in this repository.

Contributing

Anyone can contribute and improve WordOps documentation. Pull requests are warmly welcome.

You can either edit page content from Github or fork the repository before cloning it on your computer to work with the text editor of your choice.

If you have any question about this documentation, feel free to join us on Slack or to ask your question on WordOps Community forum

Method 1: Edit page content directly from Github

edit

  1. Browse the documentation and use the edit button available on the top right to open the file with Github editor
  2. Edit content directly from Github by browsing the folder docs and by using the button "edit this file" available on the right.
  3. Github will automatically fork the repository (copy the repository in your account)
  4. After you finished making changes, you will be able to commit changes (saving changes with a message which describe what was added/changed/removed).
  5. The last step to apply changes on this repository is to open a PR(pull request). We will review the commits you made and if everything is okay, we will merge the PR.

Method 2: Work on the documentation locally

If you want to work on WordOps documentation on your computer, you just have to:

  1. Fork the repository using the button "Fork" available on the top right of this page

  2. clone the forked repository:

    • with the CLI: git clone https://github.com/YourUsername/docs.wordops.net.git
    • or using Github Desktop App

  3. create/edit markdown files

  4. commit your modification git add . && git commit -am "your commit message"

  5. push your modification git push

  6. open a pull request

Documentation structure

Documentation source files are stored inside docs directory. Here the current structure:

├── commands # commands folder
│   ├── clean.md
│   ├── debug.md
│   ├── info.md
│   ├── log.md
│   ├── maintenance.md
│   ├── secure.md
│   ├── site.md
│   ├── stack.md
│   └── update.md
├── commands.md # Page -> commands Overview
├── getting-started
│   ├── creating-sites.md
│   ├── installation-guide.md
│   ├── post-install-steps.md
│   └── prerequesites.md
├── guides # guides folder ( add your extented guides & tutorials inside)
│   └── migration-from-easyengine.md
├── guides.md # Page -> Guides Overview
├── how-to # how to folder (add your short tutorial inside)
│   └── wp-language.md
├── how-to.md # Page -> How to Overview

Each part of the documentation is stored in a separated folder. how-to is the folder used for any short tutorial or explanation about WordOps usage. guides is the folder used for any extended guide or tutorial about WordOps.

Example:

I want to write a tutorial to explain how to use WordOps with a remote MySQL server.

Create the file remote-mysql-server.md in the folder how-to.

Working with mkdocs

WordOps documentation is built with mkdocs and mkdocs-material.

Mkdocs provide the ability to build a static documentation site, with source files written in Markdown, and configured with a single YAML configuration file. MkDocs builds completely static HTML sites that you can host on GitHub page or anywhere else.

You can install Mkdocs locally to use the site live preview feature.

  • install mkdocs:
  • start mkdocs built-in web-server mkdocs serve or mkdocs.exe serve inside the repository folder
  • browse documentation live preview on http://127.0.0.1:8000

You can learn more about mkdocs usage on the official documentation