Call for volunteers: merge http://opticalenquiry.com/nuke/ into Natron doc

Sure @magdesign and @Shrinks99. I fully understand that wiki is not the best for documentation and also current method is easy for developers. I felt it is quite difficult for non-programmers to support Natron, so everything is burden of few persons. Shouldn’t of course change anything by random request if that ends up having documentation maintenance totally neglected.

And nothing official should locate in 2 places to be maintained. That would be waste of time. Also I don’t know how many Natron users there are, so maybe it is not possible to get more contributors no matter where documentation Is is located.

Documents are anyway not the most important for keeping the software project alive and I’m very happy to see that it is maintained by rodlie, although I think very much alone. And Devernay seems to be keeping all in order. Even new version was released that I haven’t downloaded yet.

Long message again, but maybe my earlier post was more for myself to remember to start following this forum again and using Natron when getting some free time. :smile:

I agree that it is hard for non-programmers to get started on things like a version control system; indeed I am myself a programmer, and I still find it intimidating to contribute to Natron’s massive codebase!

I’ve hosted a simple editable wiki here: https://hackmd.io/@4Hwha1m4Tgm-uIGs2O6kwg/SkdrzENDO/edit. It is formatted with markdown which has a really simple syntax. I can merge this periodically into the main Natron docs, and there are a plethora of markdown to rst converters out there. If you have time to, feel free to add to the docs there.

Hi,
The hackmd.io as a draft of Natron docs is ok for me if it support images import/export.

I subscribed as “bonalex” to hackmd.io to contribute but it seems I don’t have write permissions could @Songtech-0912 invite me to the document.

@bonalex01 I’ve changed the permissions to allow for anyone to edit. Use this link now: https://hackmd.io/@Songtech-0912/SkdrzENDO/edit

How do you register to make edits?

HueKeyer Node.pdf (1011.9 KB)

Simple tutorial PDF for the HueKeyer node

What part of the registration process is not working for you? I’m curious, because you don’t need to be registered to edit it.

Also, I’m porting your tutorial PDF to HackMD.

@Songtech-0912 all good now. I made some changes.
Thanks

We’ll need to work on multiple documents to keep things manageable it seems.

I started to work on this:

as a work on conversion from this:
http://www.opticalenquiry.com/nuke/index.php?title=Read

I you create a “team” in hackmd vocabulary it seems I could transfer ownership of the document to that team.

What do you think ? Is it the way to go ?

By the way I don’t know how to join a team on hackmd but will find ot for sure :slight_smile: if we go that route .

Actually there’s no real “team” on Hackmd, it’s mostly just a collab between me and @Shrinks99. I’ll try to create one for Natron.

Created team on HackMD - the current documentation is at https://hackmd.io/@natron-dev-awesome/r1q9T16Dd/edit and all are invited to edit and add to it!

I think I can not ask membership on hackmd team. But you can add members as per:

My hackmd username is “bonalex”
Thanks

Got it, I’ll add you in then.

I’m starting to make screenshots for the documentation. Does anyone know if a new skin of Natron is currently worked on ? If so I would need a beta version to avoid the docs feeling outdated pretty soon.

@Songtech-0912
Hi, here’s some fresh content for the documentation ready to be synced on github.
I created a root document:

following this guide:

I created two real content documents:

And a copy of HueKeyer Tutorial:

These documents link one to the other to test if we are able to maintain links and images when migrating to Natron Github Repo.

It seems the guys at hackmd already planned for a way to sync hackmd and github:
https://hackmd.io/c/tutorials/%2Fs%2Flink-with-github
This may make everyone happy about the documentation process :slight_smile:

I let you test the sync process. Please confirm when you succeed.
Thanks,
Alex.

I should add that I am way more comfortable with this than trying to work on my machine and do the git stuff.

@bonalex01 Thanks for your great work! Though syncing directly to Github would be nice, the main issue is that Natron’s docs are in RST format, while HackMD is markdown. Converting between the two formats is trivial with a bit of shell scripting and pandoc, but I want to keep the two separately and manually add the WIP docs on hackmd to Natron’s repo one at a time to ensure that the main docs are clean.

Oh yes, I had forgotten the beginning of the discussion. By the way, don’t hesitate to criticize my submissions as English is not my native language.

Hi everyone,
the opticalenquiry website seems to be down. Does anyone have a copy of it’s content ?

I’m now able to do some documentation stuff again (sent 1 pullrequest on Natron RB-2.3).

I think the hackmd.io experiment is not successful for me because:

  • doesn’t deal with the important step of interlinking the different pages of the documentation.
  • it badly renames images
  • as we knew it requires translation from md to rst.

My new workflow:
Visual studio code
RestructuredText VSCode extension (provides sphinx compilation)
GIT publishing tools of VSCode to send the result strait to github

https://web.archive.org/web/20190119082952/http://www.opticalenquiry.com/nuke/index.php?title=Main_Page

From 2019, but I guess the content has not changed(?).