Bug #9905

Documentation for a complete workflow concerning doc modification through patches: clone - build wiki - send patch

Added by BitingBird 2015-08-05 08:45:00 . Updated 2018-08-18 11:08:49 .

Status:
Confirmed
Priority:
Low
Assignee:
Category:
Target version:
Start date:
2015-08-05
Due date:
% Done:

0%

Feature Branch:
Type of work:
Contributors documentation
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description

clarify expected documentation level to contributors
clarify doc-specific process for new contributors


Subtasks


Related issues

Related to Tails - Feature #9907: Add a small link in the footer of webpages like "found a bug?" linking to the contribute/doc documentation Confirmed 2015-08-05

History

#1 Updated by BitingBird 2015-08-05 08:45:10

  • Status changed from New to Confirmed

#2 Updated by BitingBird 2015-08-05 08:47:44

  • blocked by Feature #9907: Add a small link in the footer of webpages like "found a bug?" linking to the contribute/doc documentation added

#3 Updated by BitingBird 2015-08-05 08:47:51

  • blocks deleted (Feature #9907: Add a small link in the footer of webpages like "found a bug?" linking to the contribute/doc documentation)

#4 Updated by BitingBird 2015-08-05 08:48:00

  • blocks Feature #9907: Add a small link in the footer of webpages like "found a bug?" linking to the contribute/doc documentation added

#5 Updated by BitingBird 2015-08-05 08:51:42

  • Description updated

#6 Updated by BitingBird 2015-08-05 08:52:09

  • Description updated

#7 Updated by Anonymous 2015-09-09 16:01:34

BitingBird wrote:
> clarify expected documentation level to contributors
> clarify doc-specific process for new contributors

I’m a new contributor. I’d be happy to own this if someone would sync with me and walk me through the standard operating procedure. Or send me a link to it or some rough instructions?

#8 Updated by intrigeri 2015-09-15 02:46:43

> Or send me a link to it or some rough instructions?

The best we have currently is https://tails.boum.org/contribute/how/documentation/

#9 Updated by BitingBird 2016-06-29 06:07:16

  • Assignee deleted (BitingBird)

#10 Updated by emmapeel 2016-09-25 01:59:14

I had a look at the wepbage and it could be better rearranged and maybe add a link to the Redmine fields, but not sure what else.

All the information is linked.

I will add it up for discussion on our next contributors meeting to gather more input, and then rearrange it a bit if no more suggestions are given (unless Anonymous still wants to work on this!)

#11 Updated by anonym 2016-10-03 21:50:07

  • Assignee set to emmapeel

emma, we did what we could during the meeting, which may or may not match her initial idea.

Those of us present at the meeting found the arrangement of the current docs satisfactory, but only if you already know Git (at least the basics). After a quick survey it turned out that quite a few of our current contributors pretty much got bootstrapped into Git by reading the Git instructions for our translation team. So in order to lower the barrier for contributing documentation, and perhaps even recruiting some new long-term contributors along the way, it could be worth extracting those Git instructions and make them a bit more generic, and then include them on both pages (with ikiwiki’s raw include feature).

So, emma, does this somewhat match your original idea? Would you like to work on it?

#12 Updated by emmapeel 2017-05-26 05:57:41

  • Assignee deleted (emmapeel)

anonym wrote:
>
> So, emma, does this somewhat match your original idea? Would you like to work on it?

It seems reasonable but I’m not good at fighting with inlines.

Maybe somebody else can take care of it

#13 Updated by Anonymous 2018-08-18 11:08:49

  • Priority changed from Normal to Low

would be nice to have, but nobody committed to do it → lowering priority.

#14 Updated by Anonymous 2018-08-18 11:09:19

  • blocked by deleted (Feature #9907: Add a small link in the footer of webpages like "found a bug?" linking to the contribute/doc documentation)

#15 Updated by Anonymous 2018-08-18 11:09:24

  • related to Feature #9907: Add a small link in the footer of webpages like "found a bug?" linking to the contribute/doc documentation added