Skip to content
Open
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
65 changes: 52 additions & 13 deletions technical/DevBook.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,65 @@
layout: default
---

# Contributing to the Developer Handbook
# Contributing to the Handbook

Technical information for contributors interested to work on Developer Handbook.
Some information for people that want to work on this handbook.

<!-- ## Structure TODO: add more content later -->
<br/>

## Running locally
## Setup ( Linux )

To run the Developer Handbook locally, Jekyll, the Ruby static site generator, must be executed on the corresponding folder.\
On a Debian or Ubuntu GNU/Linux system, Bundler is used :
The handbook uses [Jekyll] to render
markdown files as a static website.

<br/>

### Repository

Clone the repository to your system.

```sh
git clone https://github.com/FreeCAD/DevelopersHandbook
```
$ sudo apt install ruby-bundler ruby-dev build-essential
$ bundle install
$ cd path/to/your/local/fork/of/the/devhandbook
$ bundle exec jekyll serve

And navigate to the repository folder.

```sh
cd DevelopersHandbook
```

Open then the link to `127.0.0.1:4000` (or `localhost:4000`) in you web browser.
<br/>

### Dependencies

Install [Ruby] and the build essentials.

```sh
sudo apt install \
build-essential \
ruby-bundler \
ruby-dev

bundle install
```
<br/>

## Editing

While editing the markdown files, run Jekyll.

```sh
bundle exec jekyll serve
```

Open the address shown in your terminal in
your browser - usually it's `127.0.0.1:4000`

<img width = '100%' src = './resources/Handbook-Serving-Terminal.webp' />

<img width = '100%' src = './resources/Handbook-Serving-Browser.webp' />

<!-- ## Design guidelines TODO: add more content later -->
<br/>

<!-- ## Resources TODO: add more content later -->
[Jekyll]: https://jekyllrb.com
[Ruby]: https://www.ruby-lang.org
Binary file added technical/resources/Handbook-Serving-Browser.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.