* [PATCH] Documentation: rename "UUID" to "UUID Reference"
@ 2022-11-16 10:54 Alyssa Ross
2022-11-17 12:55 ` Jenni Nikolaenko
2022-11-18 10:17 ` Alyssa Ross
0 siblings, 2 replies; 3+ messages in thread
From: Alyssa Ross @ 2022-11-16 10:54 UTC (permalink / raw)
To: devel; +Cc: Jenni Nikolaenko
The purpose of this document is specifically to provide a reference
table so that developers working with Spectrum can easily look up a
given UUID to find out what it means.
I think "UUID Reference" makes it clearer what the reader will find in
this document, as I'd expect a document just called "UUID" to be
something that explained e.g. what a UUID is. (I don't think we need
to explain that at all in the Spectrum documentation, as we link to
Wikipedia, which explains it well, and it's background knowledge that
most developers looking to work with Spectrum will likely already
have.)
Signed-off-by: Alyssa Ross <alyssa.ross@unikie.com>
Cc: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
---
Documentation/appendices/uuid-reference.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/appendices/uuid-reference.adoc b/Documentation/appendices/uuid-reference.adoc
index 146c068..5099ec3 100644
--- a/Documentation/appendices/uuid-reference.adoc
+++ b/Documentation/appendices/uuid-reference.adoc
@@ -1,4 +1,4 @@
-= Appendix B. UUID
+= Appendix B. UUID Reference
:page-parent: Appendices
:toclevels: 1
:page-nav_order: 2
base-commit: 395346bd3341fd0468bc4f8a9c427440c5d05438
--
2.35.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] Documentation: rename "UUID" to "UUID Reference"
2022-11-16 10:54 [PATCH] Documentation: rename "UUID" to "UUID Reference" Alyssa Ross
@ 2022-11-17 12:55 ` Jenni Nikolaenko
2022-11-18 10:17 ` Alyssa Ross
1 sibling, 0 replies; 3+ messages in thread
From: Jenni Nikolaenko @ 2022-11-17 12:55 UTC (permalink / raw)
To: devel
Yes, let's change.
I changed it before as the very word ‘reference’ confuses me a little here. I used it in a slightly different way:
a) more like a section with a list of all the sources you have quoted in alphabetical order according to the author’s last name.
For example http://iwrite.unsw.edu.au/iwrite/ENGINEERING/Reports/Group-Project-Report/References-and-Appendix.html
b) like API reference manual, but here we have the word ‘manual’.
If this option is more acceptable, let's use it.
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] Documentation: rename "UUID" to "UUID Reference"
2022-11-16 10:54 [PATCH] Documentation: rename "UUID" to "UUID Reference" Alyssa Ross
2022-11-17 12:55 ` Jenni Nikolaenko
@ 2022-11-18 10:17 ` Alyssa Ross
1 sibling, 0 replies; 3+ messages in thread
From: Alyssa Ross @ 2022-11-18 10:17 UTC (permalink / raw)
To: Alyssa Ross, devel; +Cc: Jenni Nikolaenko
This patch has been committed as c2017dcbf690fd5e412a739d6e575efae86c5c12,
which can be viewed online at
https://spectrum-os.org/git/spectrum/commit/?id=c2017dcbf690fd5e412a739d6e575efae86c5c12.
This is an automated message. Send comments/questions/requests to:
Alyssa Ross <hi@alyssa.is>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-11-18 10:17 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-16 10:54 [PATCH] Documentation: rename "UUID" to "UUID Reference" Alyssa Ross
2022-11-17 12:55 ` Jenni Nikolaenko
2022-11-18 10:17 ` Alyssa Ross
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).