Re: [rdf4j-dev] Writing docs

[Andreas Schwarte <aschwarte10@xxxxxxxxx>]

Hi,

thanks Jeen. This was exactly the pointer I needed.

A hint from my side: if you don't want to install additional tools such as hugo on your system, you can simply spin this up in a docker environment

> cd <path-to-rdf4j-doc>/site

> docker run --rm --name "rdf4j-hugo" -p 1313:1313 -v $(pwd):/src -v $(pwd)/output:/output -e HUGO_WATCH="true" -e HUGO_THEME="hugo-solstice-theme"  jojomi/hugo

Then the site is available on http://localhost:1313/

Note that the initial deployment in the container takes a while (and quite a bit of CPU load). However, once it is running it will automatically watch for changes.

@jeen: if the above is helpful I can write a paragraph in the "developer workflow" documentation.

Best,

 Andreas

Am Fr., 4. Okt. 2019 um 00:58 Uhr schrieb Jeen Broekstra <jeen.broekstra@xxxxxxxxx>:

Hi Andreas, others,

I can't find back where you said this Andreas but I remember you asked how to go about writing documentation.

There's no full developer guide for this (we really should have at least a Readme), but we use Hugo as our content platform.

You'll find the documentation sources (markdown syntax) in /site/content/documentation/. I suggest putting fedx docs in their own subdir under programming for now. Use some of the other docs for examples.

Protip: you can spin up a local Hugo server with `hugo server -d`. You will be able to see the site on localhost:1313 so you can check your edits are legit before committing and pushing.

Also: the master branch is continuously deployed, so don't push straight to it. Put up a PR.

On my phone so brief. Happy to assist where needed.

HTH,

Jeen

_______________________________________________
rdf4j-dev mailing list
rdf4j-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/rdf4j-dev