Design documentation wiki?

Development
#1

Somewhere in between email threads and Redmine issues lies the space
were you take a set of users stories and write a design with UX mockups,
API specs, model changes, upgrade issues and the like.

In the past in Katello we hosted this on our Fedorahosted wiki:

https://fedorahosted.org/katello/

as we move to move all of the docs contained there to our formal
katello.org documentation:

http://www.katello.org/docs/

we still need a place for discussion around the designs for features we
are working on. My proposal is:

  1. Decomission fedorahosted.org/katello entirely

  2. Create a "Design Wiki" on Redmine:

http://projects.theforeman.org/projects/katello/wiki

This wiki would ONLY be used for designs, no formalized documentation.
This gets us:

  • A public space for us to collaborate on designs that need to go beyond
    an email thread

  • Allows us to host mockups and other design related items

  • It can be a historical place of record on 'how we got here' for things
    we build

I've not used Redmine's wiki at all so it would be good to hear if
people have any background if this is a good tool choice for this purpose.

Mike

··· -- Mike McCune mmccune AT redhat.com Red Hat Engineering | Portland, OR Systems Management | 650-254-4248
#2

Yes please. I have some redesign I need for activation keys and am looking for a place to start.

··· ----- Original Message ----- > Somewhere in between email threads and Redmine issues lies the space > were you take a set of users stories and write a design with UX mockups, > API specs, model changes, upgrade issues and the like. > > In the past in Katello we hosted this on our Fedorahosted wiki: > > https://fedorahosted.org/katello/ > > as we move to move all of the docs contained there to our formal > katello.org documentation: > > http://www.katello.org/docs/ > > we still need a place for discussion around the designs for features we > are working on. My proposal is: > > 1) Decomission fedorahosted.org/katello entirely > > 2) Create a "Design Wiki" on Redmine: > > http://projects.theforeman.org/projects/katello/wiki > > This wiki would *ONLY* be used for designs, no formalized documentation. > This gets us: > > * A public space for us to collaborate on designs that need to go beyond > an email thread > > * Allows us to host mockups and other design related items > > * It can be a historical place of record on 'how we got here' for things > we build > > I've not used Redmine's wiki at all so it would be good to hear if > people have any background if this is a good tool choice for this purpose. > > Mike > > -- > Mike McCune > mmccune AT redhat.com > Red Hat Engineering | Portland, OR > Systems Management | 650-254-4248 > > -- > You received this message because you are subscribed to the Google Groups > "foreman-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. >
#3

> Somewhere in between email threads and Redmine issues lies the space
> were you take a set of users stories and write a design with UX mockups,
> API specs, model changes, upgrade issues and the like.
>
> In the past in Katello we hosted this on our Fedorahosted wiki:
>
> https://fedorahosted.org/katello/
>
> as we move to move all of the docs contained there to our formal
> katello.org documentation:
>
> http://www.katello.org/docs/
>
> we still need a place for discussion around the designs for features we
> are working on. My proposal is:
>
> 1) Decomission fedorahosted.org/katello entirely
>
> 2) Create a "Design Wiki" on Redmine:
>
> Wiki - Katello - Foreman
>
> This wiki would ONLY be used for designs, no formalized documentation.
> This gets us:
>
> * A public space for us to collaborate on designs that need to go beyond
> an email thread
>
> * Allows us to host mockups and other design related items
>
> * It can be a historical place of record on 'how we got here' for things
> we build
>
> I've not used Redmine's wiki at all so it would be good to hear if
> people have any background if this is a good tool choice for this purpose.

I like this idea. I like the idea of having all of the assets visible to the community. We really just need a place house documents and write up user stories and usecases. This will also help with version control. In the past the portion of the Katello wiki we used for this worked well. I know other large communities do this and it has been successful.

··· ----- Original Message -----

Mike

–
Mike McCune
mmccune AT redhat.com
Red Hat Engineering | Portland, OR
Systems Management | 650-254-4248

–
You received this message because you are subscribed to the Google Groups
"foreman-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.

#4

I used it a lot previously and I think it's good tool for this purpose. Also
there are redmine plugins adding more features if needed (graphviz
intergration, tagging, comments, cross project linking, sortable tables, etc
[1])

[1] http://www.r-labs.org/projects/r-labs/wiki/Wiki_Extensions_en

··· On Friday 26 of September 2014 11:43:28 Mike McCune wrote: > Somewhere in between email threads and Redmine issues lies the space > were you take a set of users stories and write a design with UX mockups, > API specs, model changes, upgrade issues and the like. > > In the past in Katello we hosted this on our Fedorahosted wiki: > > https://fedorahosted.org/katello/ > > as we move to move all of the docs contained there to our formal > katello.org documentation: > > http://www.katello.org/docs/ > > we still need a place for discussion around the designs for features we > are working on. My proposal is: > > 1) Decomission fedorahosted.org/katello entirely > > 2) Create a "Design Wiki" on Redmine: > > http://projects.theforeman.org/projects/katello/wiki > > This wiki would *ONLY* be used for designs, no formalized documentation. > This gets us: > > * A public space for us to collaborate on designs that need to go beyond > an email thread > > * Allows us to host mockups and other design related items > > * It can be a historical place of record on 'how we got here' for things > we build > > I've not used Redmine's wiki at all so it would be good to hear if > people have any background if this is a good tool choice for this purpose.

–
Marek