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 
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
From 2019, but I guess the content has not changed(?).
I sent an email to Martin Constable to see if we can get the wiki archive in another form.
2 Likes
Just zip it or something, I can host it temporarily if needed.
Thanks Fred. It would be really useful to get these documents because the web archive is not always available and lacks images
Agreed on hackmd not being an ideal tool. However, I really liked the realtime collaborative aspect of it, as well as the fact could be (pre)viewed online with no build setup.
Ideally, and this is very far away, we could create a similar web-based client for Natron, just for specifically editing rST, and once users edit the docs, then their changes are automatically sent via PR to Natron’s GitHub. I have an idea or two about implementation, and I’ve tried out something similar, but it is something very far away for sure.
We can keep hackmd for interactivity. For example tracking todo’s. But I think a better short time option would be to use a free account on an kanban website. What do you think ? (I’ve created one for my own todo list)
Kanban would be better, yes. Github also has a “projects” feature which is very similar to kanban and is good for project tracking (maybe even better because it can be directly tied to Github issues and PRs).
Hackmd for now is just a mirror site for easier collaboration, and for new contributors who don’t know the rST syntax to easily write things down. It has always required a manual contributor to actually convert hackmd’s markdown into properly-formatted rST (which is why pandoc doesn’t cut it), so it is by no means a primary option, but it should still be there for new contributors who don’t know rST to be able to contribute.
I followed your advice and created this:
Now we have to manage shared access to this. My understanding is that we should replicate this on NatronGithub account and Fred would manage access rights, am I right ?
1 Like
OpticalEnquiry is back online. I make a copy of it with HTTTrack just in case.
Yes, I think so.