patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: "Jenni Nikolaenko" <evgeniia.nikolaenko@unikie.com>
To: devel@spectrum-os.org
Subject: Re: [PATCH] Docs: new structure
Date: Fri, 04 Nov 2022 13:57:22 -0000	[thread overview]
Message-ID: <166757024292.1913.13612302194626341643@atuin.qyliss.net> (raw)
In-Reply-To: <20221101121335.7zh7kxcnxyrojdfp@x220>

> > This is one of a few sentences that the patch still changes to be
> > single-spaced.
Fixed.

> > Let's wrap these at 70-80 characters too.  There's an example in the
> > AsciiDoctor documentation of how to do it (looks like it needs
> > backslashes at the end of lines):
I decided to delete these descriptions as I moved this section under the Development chapter, and it makes no sense. But I added this to our future Working with Documentation section.

> >  *The* Nix package manager, and *the* Nixpkgs package collection.
> >  Maybe we could link to them too?
Fixed.

> >  This whole page is excellent, thanks a lot!
I am glad to do this!

> >  testing-patches.adoc is about testing patches submitted by other people,
> >  so I don't think it makes sense to link to it in this context.
Fixed – You can [test patches] subbmited by others.
Oh, hell, now I can see the typo here. Ok, hello "patch v4". I will fix it while adding the Writing Documentation section.

> >  Ideally I'd like it if the documentation didn't assume familiarity with
> >  b4, because lots of people won't have used it before, it's not too well
> >  documented, and using it with Spectrum only requires learning a couple
> >  of commands.  So let's try to instead just explain everything about it
> >  somebody using it with Spectrum would need to know in our documentation?
> >  If there's missing info about it I can try to expand what we have.
Yes, let’s try to expand it.
Meanwhile, I changed it to the simple item list and added AsciiDoc there.

> > My comments from the previous version still apply here — this [example]
> > attribute shouldn't be removed, …
> > … and this was also correct before.
> > This isn't shell source code, so we shouldn't use this attribute here.
> > Spectrum, not Spectrum OS. :)
> > Since there's no way to find them in the navigation, and they don't
> > have any content or child pages, should we just delete these Diátaxis
category pages?
> > typo: grinning
> > One too many "a"s here — it's "aarch64".
All fixed. Sorry for missing it.

> > I don't think this last thing is something that an end user is likely to
> > want to do — it's really a development convenience.
I moved it to the Development chapter, now it is under the Managing VMs section.

> > Let's maybe be a bit less specific about what's in the development
> > section?  These three things are things that we have documented right
> > now, but as the documentation fills up these probably won't be the most
> > important three things somebody might be looking for.
Fixed – Once you are up and running, see [Development] to understand how to work with Spectrum's code and participate in the collaborative development process.

> > "makes Nix to trust" is ungrammatical.  This should be
> > "tells Nix to trust" or "makes Nix trust".
Oops! My bad.

> > b4 is a development tool, so people don't need to wory about it to
> > install Spectrum.  And the getting-spectrum.adoc document already
> > explains about the binary cache, so I think we should just link to
> > getting-spectrum.adoc here.
I reorganized it a little bit. Now configuring b4 is in the patches section under the Development chapter.
Also, I added a general workflow description.

> > "If you have the configuration layer" doesn't really make sense to me.
> > Maybe we could say:
> > If you need to customise the build, for example to use a vendor kernel,
> > you can use a xref:../development/bulid-configuration.adoc[build
> > configuration file].
Fixed.



  reply	other threads:[~2022-11-04 13:57 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <RE: [PATCH] Docs: new structure>
2022-10-28 11:05 ` [PATCH] Docs: new structure Jenni Nikolaenko
2022-10-28 11:24   ` Jenni Nikolaenko
2022-11-01 12:14     ` Alyssa Ross
2022-11-01 12:13   ` Alyssa Ross
2022-11-04 13:57     ` Jenni Nikolaenko [this message]
2022-11-08  9:03       ` Alyssa Ross
2022-11-08 15:05         ` Jenni Nikolaenko
2022-09-06 13:55 Jenni Nikolaenko
2022-09-19  9:30 ` Alyssa Ross
2022-09-28 12:52   ` Jenni N
2022-09-29  8:58     ` Alyssa Ross
2022-10-28 11:22   ` Jenni Nikolaenko

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=166757024292.1913.13612302194626341643@atuin.qyliss.net \
    --to=evgeniia.nikolaenko@unikie.com \
    --cc=devel@spectrum-os.org \
    /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).