Ubuntu Documentation - Getting Started

[Doug Smythies]

On 2013.08.16 21:12 Kevin wrote:

> In addition, I propose that we remove the 'Configure your shell' and
> 'Updating the changelog' sections as that's more of a packaging issue
> than a contributor issue. This means the contributor won't need all of
> the packages we have them installing at the top of the page.

Good points.
Edits done. We can revert if there is disagreement.

> Here are my thoughts on the getting started page:

> The getting started page is aimed at new documentation contributors.
> Many of these contributors may be interested in helping Ubuntu and
> think that documentation is something they can start with as they're
> not developers.  So the getting started page needs to provide them
> with the minimal steps required for them to start contributing to the
> project. We don't want them to have to jump through any extraneous
> hoops (e.g., installing things only used for packaging, setting up
> unnecessary GPG keys).  We should aim to make contributing to the
> documentation as simple and painless as possible.

I agree, and that is where my edits have been trying to move towards.

> On a separate page (or pages if necessary), we should document the
> complete procedure for packaging the documentation. These instructions
> should also be comprehensive and easy to follow. This page can contain
> the steps for maintaining the changelog, creating the GPG keys and
> using them to sign the packages, etc.  This page should cover the
> entire release process including packaging and pushing to the web.

O.K., I agree. And that page can link to the packaging getting
started page for a bunch of the content.

... Doug