Skip to content

Commit

Permalink
DEVELOP: Move Developer Guide to canonical Authoring Guide
Browse files Browse the repository at this point in the history
The new canonical spot is slotted into the crate-docs-theme now, to
reduce redundancy and improve maintainability.
  • Loading branch information
amotl committed Mar 4, 2024
1 parent be336b4 commit 7e12cd1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 74 deletions.
76 changes: 3 additions & 73 deletions DEVELOP.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,6 @@
# Developer Guide

The documentation below guides you through the process setting up a development
sandbox suitable for convenient editing with live reloading, i.e. just type
`make dev`.
Set up a development sandbox suitable for convenient editing with live
reloading, i.e. just type `make dev`. Please refer to the [Authoring Guide].


## Prerequisites

For running the documentation build and sandbox, you will need an installation
of Python on your workstation.

For conveniently searching within the content of the working tree from the
command line, the authors also recommend to install the [ripgrep] or [The
Silver Searcher] program.


## Setup

In order to spin up a development environment for live editing, based on
[crate-docs], in turn using [sphinx-autobuild], acquire the sources, and
invoke `make dev`.

```shell
git clone https://github.com/crate/cratedb-guide
cd cratedb-guide/docs
```


## Sandbox Operations

### Live Reloading
When invoking the live editing mode, the documentation will be compiled and
served by a development web server.
```shell
make dev
```
When connecting to it using a browser, and editing the files using the editor
of your choice, filesystem changes will be detected, documentation will be
recompiled, and a refresh event will be propagated to the browser.

### Link Checker
To invoke the link checker, which is also part of the PR validation on CI.
```shell
make check
```

### Rendering
To render the documentation, one-shot, without live editing.
```shell
make html
```

### Reset
Reset the embedded `docs/.crate-docs` directory, in order to fetch a new
version next time.
```shell
make reset
```


## Publishing

This project uses [Read the Docs] for publishing, thanks to their team for
the excellent service.

If you submit a pull request to the project on GitHub, a corresponding CI job
will provide you a rendered preview version to inspect your changes like they
would be published after integrating your patch.


[crate-docs]: https://github.com/crate/crate-docs
[Read the Docs]: https://about.readthedocs.com/
[ripgrep]: https://github.com/burntsushi/ripgrep
[sphinx-autobuild]: https://pypi.org/project/sphinx-autobuild/
[The Silver Searcher]: https://github.com/ggreer/the_silver_searcher
[Authoring Guide]: https://crate-docs-theme.readthedocs.io/en/latest/authoring.html
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ about how to contribute to CrateDB repositories.
[developer docs]: DEVELOP.md
[Markdown]: https://daringfireball.net/projects/markdown/
[MyST]: https://myst-parser.readthedocs.io/
[Read the Docs]: https://about.readthedocs.com/
[reStructuredText]: https://docutils.sourceforge.io/rst.html
[searching for "flink"]: https://cratedb.com/docs/guide/search.html?q=flink
[Sphinx]: https://www.sphinx-doc.org/
[sphinx-design]: https://sphinx-design.readthedocs.io/
[sphinx-design-elements]: https://sphinx-design-elements.readthedocs.io/
[Read the Docs]: https://about.readthedocs.com/

0 comments on commit 7e12cd1

Please sign in to comment.