* [PATCH] Documentation: move "Working with Patches" under "Contributing"
@ 2023-02-11 14:56 Alyssa Ross
2023-02-21 23:05 ` Alyssa Ross
0 siblings, 1 reply; 2+ messages in thread
From: Alyssa Ross @ 2023-02-11 14:56 UTC (permalink / raw)
To: devel; +Cc: Jenni Nikolaenko
This is all information about how to contribute to Spectrum, so I
think it makes more sense here than under "Development".
Signed-off-by: Alyssa Ross <hi@alyssa.is>
---
Documentation/{development => contributing}/b4.adoc | 2 +-
Documentation/contributing/building-documentation.adoc | 4 ++--
Documentation/contributing/communication.adoc | 2 +-
.../{development => contributing}/first-patch.adoc | 2 +-
Documentation/contributing/index.adoc | 6 +++---
Documentation/{development => contributing}/replying.adoc | 2 +-
.../{development => contributing}/reviewing-patches.adoc | 2 +-
.../{development => contributing}/testing-patches.adoc | 2 +-
.../working-with-patches.adoc | 8 ++++----
Documentation/contributing/writing_documentation.adoc | 2 +-
10 files changed, 16 insertions(+), 16 deletions(-)
rename Documentation/{development => contributing}/b4.adoc (98%)
rename Documentation/{development => contributing}/first-patch.adoc (98%)
rename Documentation/{development => contributing}/replying.adoc (97%)
rename Documentation/{development => contributing}/reviewing-patches.adoc (95%)
rename Documentation/{development => contributing}/testing-patches.adoc (98%)
rename Documentation/{development => contributing}/working-with-patches.adoc (58%)
diff --git a/Documentation/development/b4.adoc b/Documentation/contributing/b4.adoc
similarity index 98%
rename from Documentation/development/b4.adoc
rename to Documentation/contributing/b4.adoc
index 5f141e9..b41dc58 100644
--- a/Documentation/development/b4.adoc
+++ b/Documentation/contributing/b4.adoc
@@ -1,6 +1,6 @@
= Installing and Configuring b4
:page-parent: Working with Patches
-:page-grand_parent: Development
+:page-grand_parent: Contributing
:page-nav_order: 1
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
diff --git a/Documentation/contributing/building-documentation.adoc b/Documentation/contributing/building-documentation.adoc
index 63a3038..1beffa8 100644
--- a/Documentation/contributing/building-documentation.adoc
+++ b/Documentation/contributing/building-documentation.adoc
@@ -1,6 +1,6 @@
= Building Documentation
:page-parent: Contributing
-:page-nav_order: 3
+:page-nav_order: 4
// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -49,4 +49,4 @@ modify any of those, or add new ones, run `scripts/build.sh` again to do a full
rebuild of the site.
After making changes to the documentation, see how to
-xref:../development/first-patch.adoc[send your patch] and submit the changes for review.
+xref:first-patch.adoc[send your patch] and submit the changes for review.
diff --git a/Documentation/contributing/communication.adoc b/Documentation/contributing/communication.adoc
index bb8aeb9..9344cdf 100644
--- a/Documentation/contributing/communication.adoc
+++ b/Documentation/contributing/communication.adoc
@@ -81,7 +81,7 @@ and where patches are sent.
There is a separate guide for the Spectrum development process,
including how patches are sent to this list and discussed.
For more information, see
-xref:../development/working-with-patches.adoc[Working with Patches].
+xref:working-with-patches.adoc[Working with Patches].
You can subscribe
xref:https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*.
diff --git a/Documentation/development/first-patch.adoc b/Documentation/contributing/first-patch.adoc
similarity index 98%
rename from Documentation/development/first-patch.adoc
rename to Documentation/contributing/first-patch.adoc
index aa6ebee..13efa33 100644
--- a/Documentation/development/first-patch.adoc
+++ b/Documentation/contributing/first-patch.adoc
@@ -1,6 +1,6 @@
= Sending Your Patch
:page-parent: Working with Patches
-:page-grand_parent: Development
+:page-grand_parent: Contributing
:page-nav_order: 1
// SPDX-FileCopyrightText: 2022 Unikie
diff --git a/Documentation/contributing/index.adoc b/Documentation/contributing/index.adoc
index 4be8d69..48255d8 100644
--- a/Documentation/contributing/index.adoc
+++ b/Documentation/contributing/index.adoc
@@ -24,7 +24,7 @@ If you have made changes you would like to be included
in the official Spectrum distribution, please send patches
to the spectrum-devel mailing list (devel@spectrum-os.org).
For more information, see
-xref:../development/working-with-patches.adoc[Working with Patches].
+xref:working-with-patches.adoc[Working with Patches].
Sending patches to the list is easy — you can do it with Git,
straight from the command line. You do not have to set anything up
@@ -60,7 +60,7 @@ this style of collaboration can be compared to the alternatives.
If you notice something that can be fixed or improved:
-. xref:https://spectrum-os.org/doc/development/first-patch.html#making-changes[Edit or add any relevant documentation].
+. xref:first-patch.html#making-changes[Edit or add any relevant documentation].
+
TIP: Make sure your changes are formatted correctly and consistently
with the rest of the documentation. For information on writing guidelines,
@@ -68,7 +68,7 @@ see xref:../contributing/writing_documentation.adoc[Documentation Style Guide].
+
. xref:../contributing/building-documentation.adoc[Test your documentation].
Reread what you wrote and run a spellchecker on it to make sure you did not miss anything.
-. xref:https://spectrum-os.org/doc/development/first-patch.html#submitting-changes[Submit changes].
+. xref:first-patch.html#submitting-changes[Submit changes].
=== Documentation To-Do List
diff --git a/Documentation/development/replying.adoc b/Documentation/contributing/replying.adoc
similarity index 97%
rename from Documentation/development/replying.adoc
rename to Documentation/contributing/replying.adoc
index a1ad394..63fbba8 100644
--- a/Documentation/development/replying.adoc
+++ b/Documentation/contributing/replying.adoc
@@ -1,6 +1,6 @@
= Replying to Messages in the Mailing List Archives
:page-parent: Working with Patches
-:page-grand_parent: Development
+:page-grand_parent: Contributing
:page-nav_order: 3
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
diff --git a/Documentation/development/reviewing-patches.adoc b/Documentation/contributing/reviewing-patches.adoc
similarity index 95%
rename from Documentation/development/reviewing-patches.adoc
rename to Documentation/contributing/reviewing-patches.adoc
index ba47f25..2f7b0fc 100644
--- a/Documentation/development/reviewing-patches.adoc
+++ b/Documentation/contributing/reviewing-patches.adoc
@@ -1,6 +1,6 @@
= Reviewing Patches
:page-parent: Working with Patches
-:page-grand_parent: Development
+:page-grand_parent: Contributing
:page-nav_order: 2
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
diff --git a/Documentation/development/testing-patches.adoc b/Documentation/contributing/testing-patches.adoc
similarity index 98%
rename from Documentation/development/testing-patches.adoc
rename to Documentation/contributing/testing-patches.adoc
index 0c72c93..f76f873 100644
--- a/Documentation/development/testing-patches.adoc
+++ b/Documentation/contributing/testing-patches.adoc
@@ -1,6 +1,6 @@
= Testing Patches
:page-parent: Working with Patches
-:page-grand_parent: Development
+:page-grand_parent: Contributing
:page-nav_order: 2
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
diff --git a/Documentation/development/working-with-patches.adoc b/Documentation/contributing/working-with-patches.adoc
similarity index 58%
rename from Documentation/development/working-with-patches.adoc
rename to Documentation/contributing/working-with-patches.adoc
index a2694ed..dfd4ed5 100644
--- a/Documentation/development/working-with-patches.adoc
+++ b/Documentation/contributing/working-with-patches.adoc
@@ -1,6 +1,6 @@
= Working with Patches
-:page-parent: Development
-:page-nav_order: 3
+:page-parent: Contributing
+:page-nav_order: 2
:page-has_children: true
// SPDX-FileCopyrightText: 2022 Unikie
@@ -8,5 +8,5 @@
Patches are the way for contributors to submit code to the Spectrum project.
-Make sure to xref:../development/b4.adoc[install and configure the b4 utility]
-for applying and testing other people's patches.
+Make sure to xref:b4.adoc[install and configure the b4 utility] for
+applying and testing other people's patches.
diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/contributing/writing_documentation.adoc
index a58da64..f8a69ef 100644
--- a/Documentation/contributing/writing_documentation.adoc
+++ b/Documentation/contributing/writing_documentation.adoc
@@ -1,6 +1,6 @@
= Documentation Style Guide
:description: Channels, announcements and so on.
-:page-nav_order: 2
+:page-nav_order: 3
:page-parent: Contributing
// SPDX-FileCopyrightText: 2023 Unikie
--
2.37.1
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: move "Working with Patches" under "Contributing"
2023-02-11 14:56 [PATCH] Documentation: move "Working with Patches" under "Contributing" Alyssa Ross
@ 2023-02-21 23:05 ` Alyssa Ross
0 siblings, 0 replies; 2+ messages in thread
From: Alyssa Ross @ 2023-02-21 23:05 UTC (permalink / raw)
To: Alyssa Ross, devel; +Cc: Jenni Nikolaenko
This patch has been committed as b0e74a9f5d37d5f16372617fe8f404b24a56ddd2,
which can be viewed online at
https://spectrum-os.org/git/spectrum/commit/?id=b0e74a9f5d37d5f16372617fe8f404b24a56ddd2.
This is an automated message. Send comments/questions/requests to:
Alyssa Ross <hi@alyssa.is>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-02-21 23:06 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-02-11 14:56 [PATCH] Documentation: move "Working with Patches" under "Contributing" Alyssa Ross
2023-02-21 23:05 ` 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).