Re: New person; looking for a task

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi!

We switched from DocBook to ASCIIDoc and Antora a while ago. Don't worry
though, it's fairly easy to pick up. Here's some guides:

* https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ - this
should be enough in pretty much all cases
* https://asciidoctor.org/docs/user-manual/ - this goes way more in depth

The link to our contributor docs Eduard sent you earlier is also helpful
since it deals with some specifics of our publication system (Antora).
I'm currently working on massively improving that doc set, but what we
currently have should at least get you started. Also check the README in
the template repo for a crash course on how each repo works and how to
build a local preview: https://pagure.io/fedora-docs/template

For some easy tasks, we could use some reviewers for quick-docs.
Quick-docs are a set of former, popular Wiki pages that didn't really
belong on the Wiki but into user documentation instead, so they were
migrated to our docs site. The published version is here:
https://docs.fedoraproject.org/en-US/quick-docs/

In the repository (which you'll find if you click Edit this page in the
top right corner) there are a couple pages that aren't yet published;
there are instructions on the index page:
https://docs.fedoraproject.org/en-US/quick-docs/#_steps . You don't need
to fix all of them, any effort helps.

On top of that we're also looking for people who can review content of
most of the quick-docs pages for technical accuracy - some of them are
pretty old and might be outdated. The ones that need a review have a
banner on top indicating they need a review, for example here:
https://docs.fedoraproject.org/en-US/quick-docs/repositories/. Check the
README (linked in the banner) for instructions on fixing that.

Other than that, in roughly a month F31 beta will be released and we'll
start writing release notes; those great for a newcomer since it's a
series of small, relatively simple tasks. I'll send a mail with
instructions to this list when it's time to get started - according to
the current schedule
(https://fedoraproject.org/wiki/Releases/31/Schedule) this should be on
September 17 or September 24.

You can also go through the docs repositories (
https://pagure.io/projects/fedora-docs/%2A ) and check their open
issues, you might find something that you'd like to fix. Be careful
though, not all of those repos are published on the site, so check for
that first - one day I'll clean that mess up :). You could even go check
some of the docs we publish but that are maintained by other teams like
the Council, Fesco, the Packaging Committee, etc., those aren't listed
in the above link because they're in a different namespace, but you can
dig them out of the sitewide config here:
https://pagure.io/fedora-docs/docs-fp-o/blob/prod/f/site.yml .

If you have any further questions (or if most of what I just said
doesn't make sense to you :), either ask on this list, or ping me on
FreeNode in #fedora-docs, nick pbokoc. I'm almost always online during
business hours in UTC+2, and sometimes during evenings.

Cheers,

Petr

On 8/13/19 11:12 AM, A Jenkins wrote:
> Hi,
> I'm sorry I haven't made it to any of the meetings but I'd like to help.
> I haven't used Gobby before but I have got a bit of experience using
> Docbook (command-line tools).
> I found https://fedoraproject.org/wiki/Docs_Project_content_tasks_for_new_contributors
> Can someone help me choose a task please?
> Adam
> _______________________________________________
> docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
> To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
> Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
> List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
> List Archives: https://lists.fedoraproject.org/archives/list/docs@xxxxxxxxxxxxxxxxxxxxxxx
_______________________________________________
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/docs@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux