Project

General

Profile

Bug #9905

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

Added by BitingBird about 4 years ago. Updated about 1 year ago.

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

0%

Feature Branch:
Type of work:
Contributors documentation
Blueprint:
Starter:
Affected tool:

Description

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


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 08/05/2015

History

#1 Updated by BitingBird about 4 years ago

  • Status changed from New to Confirmed

#2 Updated by BitingBird about 4 years ago

  • 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 about 4 years ago

  • Blocked by 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 about 4 years ago

  • 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 about 4 years ago

  • Description updated (diff)

#6 Updated by BitingBird about 4 years ago

  • Description updated (diff)

#7 Updated by Anonymous about 4 years ago

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 about 4 years ago

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 about 3 years ago

  • Assignee deleted (BitingBird)

#10 Updated by emmapeel almost 3 years ago

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 almost 3 years ago

  • 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 over 2 years ago

  • 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 u about 1 year ago

  • Priority changed from Normal to Low

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

#14 Updated by u about 1 year ago

  • Blocks 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 u about 1 year ago

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

Also available in: Atom PDF