Developer documentation guide

Hey,

I am working on a patch that fix our About Plugins page. I want to use
the new CSS stylesheets that Tomer created and eventually I will find
out how to use them today :slight_smile:

But I have this idea, why don't we start a page or document with
developer oriented information. I am sure I will forget how to do this
in a while and this kind of document would help a lot.

We already do this for plugin authors, but I don't think we have such a
thing for core. I actually need to read his patch to understand how this
works.

路路路 -- Later, Lukas #lzap Zapletal

There are a few pages under
Development Resources - Foreman,
please feel free to add to them.

路路路 On 30/10/15 08:55, Lukas Zapletal wrote: > But I have this idea, why don't we start a page or document with > developer oriented information. I am sure I will forget how to do this > in a while and this kind of document would help a lot. > > We already do this for plugin authors, but I don't think we have such a > thing for core. I actually need to read his patch to understand how this > works.


Dominic Cleal
dominic@cleal.org

I'm also interested in expanding the website developer information - I
think the wiki lacks visibility. I've made a start on re-organising
the Community tab as part fo my blog rework[1], although that commit
will probably need moving to it's own PR I think. I'm looking to pages
from other sites [2,3,4] for inspiration, but suggestions are welcome
for doing it with our usual style :wink:

[1] https://github.com/GregSutcliffe/theforeman.org/commit/32ce54044688be0cef8c2ad4e520dc1b5ee0019e
[2] http://www.ovirt.org/Develop
[3] https://pulp.readthedocs.org/en/2.6-release/dev-guide/contributing/index.html
[4] https://wiki.centos.org/Contribute

Greg

路路路 On 30 October 2015 at 09:06, Dominic Cleal wrote: > On 30/10/15 08:55, Lukas Zapletal wrote: >> But I have this idea, why don't we start a page or document with >> developer oriented information. I am sure I will forget how to do this >> in a while and this kind of document would help a lot. >> >> We already do this for plugin authors, but I don't think we have such a >> thing for core. I actually need to read his patch to understand how this >> works. > > There are a few pages under > http://projects.theforeman.org/projects/foreman/wiki/Development_Resources#Developer-documentation-and-designs, > please feel free to add to them.

> Hey,
>
> I am working on a patch that fix our About Plugins page. I want to use
> the new CSS stylesheets that Tomer created and eventually I will find
> out how to use them today :slight_smile:
>
> But I have this idea, why don't we start a page or document with
> developer oriented information. I am sure I will forget how to do this
> in a while and this kind of document would help a lot.
>
> We already do this for plugin authors, but I don't think we have such a
> thing for core. I actually need to read his patch to understand how this
> works.

Not exactly what you're asking for - but I started 2 weeks ago a
developers handbook draft to be put on theforeman.org:
https://github.com/dLobatog/theforeman.org/commit/85c13e118573248d72482478f3a6c03f83c60380

It lives on dlobatog/theforeman.org:foreman_handbook as I feel it's
anything but complete, but if you feel what is there is usable already
I'd be glad to submit it and we can iterate and add sections to it.

路路路 On 10/30, Lukas Zapletal wrote:


Later,
Lukas #lzap Zapletal


You received this message because you are subscribed to the Google Groups 鈥渇oreman-dev鈥 group.
To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Daniel Lobato Garcia

@dLobatog
blog.daniellobato.me
daniellobato.me

GPG: http://keys.gnupg.net/pks/lookup?op=get&search=0x7A92D6DD38D6DE30
Keybase: https://keybase.io/elobato

> It lives on dlobatog/theforeman.org:foreman_handbook as I feel it's
> anything but complete, but if you feel what is there is usable already
> I'd be glad to submit it and we can iterate and add sections to it.

That looks great, I'd love to see our core features to be described
there sometime! New status API, mentioned CSS styles and others!
Get this out of doors rather sooner, so others can contribute directly
to theforeman.org.

路路路 -- Later, Lukas #lzap Zapletal

> > It lives on dlobatog/theforeman.org:foreman_handbook as I feel it's
> > anything but complete, but if you feel what is there is usable already
> > I'd be glad to submit it and we can iterate and add sections to it.
>
> That looks great, I'd love to see our core features to be described
> there sometime! New status API, mentioned CSS styles and others!
> Get this out of doors rather sooner, so others can contribute directly
> to theforeman.org.

There we go -

I tried to explain the motivation in the PR description. Let's see how
it goes.

路路路 On 10/30, Lukas Zapletal wrote:


Later,
Lukas #lzap Zapletal


You received this message because you are subscribed to the Google Groups 鈥渇oreman-dev鈥 group.
To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Daniel Lobato Garcia

@dLobatog


GPG: http://keys.gnupg.net/pks/lookup?op=get&search=0x7A92D6DD38D6DE30
Keybase: https://keybase.io/elobato