Starting up the dt documentation process

Software
, ,
1

I am hoping to contribute to documenting darktable.
To do so some steps have to be taken and not always all goes well at once.
As there are more people who already know how to do this @paperdigits suggested to no longer discuss this in private.

So to all interested in joining and/or helping - a small recap of what went before.

Relevant url’s as far as I know now:

  1. Part of dt’s manual: darktable user manual - contributing to dtdocs
  2. Description what to do: dtdocs/README.md at master · darktable-org/dtdocs · GitHub
  3. List of changes still to be documented: Pull requests · darktable-org/darktable · GitHub

I already had a GitHub account and git was already installed on my pc.
From the description what to do I made a git clone and installed Hugo

Up to the SASS part of the procedure.
I found the themes at my computer at: ~/home/jetze/dtdocs/themes
Needed to:

$ cd ./themes/hugo-darktable-docs-theme/assets/
$ yarn install

Giving me the message: ‘no such file or directory’ (there is no install there at the moment).

So anyone who may help me from here…

Kind regards, Jetze

2

This worked for me:

$ cd ./themes/hugo-darktable-docs-theme/assets/
$ yarn install (or alternatively `npm install`)

However this did not:

$ cd ../../hugo-darktable-docs-pdf-theme/assets/
$ yarn install

There’s no package.json in that file so nothing to install.

But your issue might be simpler, do you have yarn or npm installed?

3

Thanks Andrew,

I did a ‘sudo apt install cmdtest’ as I understood that yarn would get installed with that. Jetze

PS
In the `/home/jetze/dtdocs/themes/hugo-darktable-docs-theme/assets is a package.json file

4

You don’t really need Hugo. You can even edit the files on GitHub, or on your PC with any text editor, and then commit and push to GitHub. GH can then show you the formatted file (not exactly as it will appear on the web page, but you’ll be able to verify links, check that images are inserted correctly, that lists are laid out as you wanted them, and so on).

Or grab an IDE that has a Markdown preview feature. The ones from JetBrains do. Most probably VS Code also has something.

1 Like
5

there is a build all script in the tools directory iirc. at least we use something like that in our build script

also

hugo serve -d public

is super awesome.

6

All right gentleman: it is 10 to 0 for you.

I’m not a developer, a complete newbie on git and GitHub and all software involved. So what’s every day’s piece of cake for you - for me is utterly indigestible.

Have a little consideration with me please…

So sorry but that’s what it is.
:innocent:

What is the most logical step as straight toward the goal I should take…

Kind regards, Jetze

7

Do you know how to format text with markdown? That’s the first place to start.

8

Never done so but will probably be not too difficult for me.
Probably need a tool for that. Does it matter which one?
Probably not. Which one would you advice: Tools | Markdown Guide

9

not really. most of those are web apps. VS Code will work and probably has a markdown plugin and is open and free.

10

Alright back again.

  1. I do have hugo installed although not yet I know how to use it, but I will manage there I guess.
  2. I assume with hugo I will be able to write text formatted in markdown. Is that correct?
  3. I was blocked when: “yarn install” failed. Does that matter and if yes what might I do?

Tomorrow I will go further along this path and surely will get hugo to work.

Kind regards, Jetze

11

Alright, before going to sleep I managed to see a rudimentary website of one .html page and one short textline.

Hows that… :smirk:

12

Hugo is only required to generate HTML. Any text editor (including Github and a browser) is sufficient, and it provides a preview, too.

1 Like
13

I may be splitting hairs, but:

it is more accurate to say that Visual Studio Code is “built” on open source, rather than “is” open source
Visual Studio Code FAQ

But yes, one can also use the OSS version from GitHub - microsoft/vscode: Visual Studio Code

14

I use it at work and its… OK? I don’t understand the hype and so I pay it almost no mind. Get the FOSS version, indeed.

15

I don’t mind using proprietary software, if it works well; for example, I use CLion for C development, and IntelliJ IDEA, its sister product, for Java.

So yes, I was definitely splitting hairs. :smiley: