OPNsense Forum

English Forums => Documentation and Translation => Topic started by: qinohe on July 04, 2018, 04:30:19 pm

Title: Share docs
Post by: qinohe on July 04, 2018, 04:30:19 pm

Hello, I have build a clean container setup for building the docs, cloned the repo and did build the docs, uploaded the result to a local web server and tested it.
Very nice, I never worked with Sphinx nor ReadTheDocs before but I may just convert my own local wiki to it, works beautiful.
Now if I understand I can just throw my .rst in the right dir. with the imgages appended & in the right dir. and it will build right? That would be very very easy.  ;D
Also, forgive my noob ness here, but I have question about git I don't use it much: I fork the repo to my own github account than do the adjustments push them back to my account.
You guys would be notified when I pushed the change to my own account, right...

Thanks mark

edit: just added my own page, nice, though that page is not ready but this super easy, I like it

Title: Re: Share docs
Post by: franco on July 04, 2018, 07:39:19 pm

Hi mark,

When you push your changes to your local GitHub account you can then open "pull requests" to the main repository. One pull request per branch per feature or bug or correction you want to make. It heavily depends on your preferred work flow and the scope of work.

For docs I'd say if you have smaller typos and wording you can batch them, but if you add new pages it makes sense to only add those and avoid touching other pages.


Thanks,
Franco

Title: Re: Share docs
Post by: qinohe on July 04, 2018, 09:18:37 pm

Hey franco, I understand your concerns and will add new page/s separate to edit's done on other pages.
Hehe, I have my hands full on this for now. I get the hang of the markup so await this first in a little while.

Well I will read myself into git a little I understand the basics so that will work out well with your tips  ;)

Greetings mark

Title: Re: Share docs
Post by: franco on July 05, 2018, 08:41:43 am

git can be hell. ;) If you have questions let us know.


Cheers,
Franco

Title: Re: Share docs
Post by: qinohe on July 05, 2018, 01:09:50 pm

Thanks, I have just forked the docs that went well, the rest will soon be history
If something isn't working I will bug you again  ;D

Greets mark

Title: Re: Share docs
Post by: qinohe on July 08, 2018, 05:23:54 pm

Good day, I'm already making fair progress on the page I'm creating, had to do a quick course on Sphinx & a refresh of HTML+CSS.
Think it's at least ten years back  :P
Now while editing the page I found there are some things not there like use of text color, is this a design decision?
If not, can I add a custom 'color' CSS to the project and add it to conf.py or is that not allowed?
I have already set it up local, works fine.  ;)

Thanks mark