From: Alyssa Ross <hi@alyssa.is>
To: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
Cc: devel@spectrum-os.org
Subject: Re: [PATCH] Documentation: add contributing information
Date: Fri, 20 Jan 2023 17:32:18 +0000 [thread overview]
Message-ID: <20230120173218.ns6qqth7rexeo4ep@x220> (raw)
In-Reply-To: <20230119154307.28303-1-evgeniia.nikolaenko@unikie.com>
[-- Attachment #1: Type: text/plain, Size: 1579 bytes --]
On Thu, Jan 19, 2023 at 05:43:07PM +0200, Jenni Nikolaenko wrote:
> Hello there!
> I decided to create a patch from my drafts so this information
> will not be lost. It still needs some attention.
>
> It is a good idea to have the documentation in one place.
> For us this means that information from these pages
> https://spectrum-os.org/contributing.html, https://spectrum-os.org/participating.html
> -- should be moved here https://spectrum-os.org/participating.html.
>
> What I did particularly:
>
> 1. Added a new chapter "Contributing".
> Copied here the information from here https://spectrum-os.org/contributing.html,
> adapting a bit to Spectrum Docs.
> 2. Moved the "Building Documentation" section from "Development" to "Contributing".
> 3. In the "Contributing" chapter you can find the following structure:
> - Communication in Spectrum (copied from https://spectrum-os.org/participating.html)
> - Documentation Style Guide
> - Building Documentation
>
> I tried to fix all cross-reference links, so this new content can be used right now.
> Any further updates are very welcome.
Thank you! I've applied the patch, with a fix for one broken link that
was identified by our new automated broken link checking. I should
write up how to run that — I'm so behind on the documentation I want to
write. :(
I think maybe the "Working with patches" section should also go under
"Contributing", what do you think?
I'll update /contributing.html and /participating.html when I get a
chance.
Thanks for your continued contributions!
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
prev parent reply other threads:[~2023-01-20 17:32 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-19 15:43 Jenni Nikolaenko
2023-01-20 17:28 ` Alyssa Ross
2023-01-20 17:32 ` Alyssa Ross [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230120173218.ns6qqth7rexeo4ep@x220 \
--to=hi@alyssa.is \
--cc=devel@spectrum-os.org \
--cc=evgeniia.nikolaenko@unikie.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://spectrum-os.org/git/crosvm
https://spectrum-os.org/git/doc
https://spectrum-os.org/git/mktuntap
https://spectrum-os.org/git/nixpkgs
https://spectrum-os.org/git/spectrum
https://spectrum-os.org/git/ucspi-vsock
https://spectrum-os.org/git/www
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).