patches and low-level development discussion
 help / color / mirror / code / Atom feed
* [PATCH] Documentation: remove redundant contributing page
@ 2026-07-07  8:58 Valentin Gagarin
  2026-07-10 13:55 ` Alyssa Ross
  2026-07-12 15:08 ` [PATCH v2] " Valentin Gagarin
  0 siblings, 2 replies; 6+ messages in thread
From: Valentin Gagarin @ 2026-07-07  8:58 UTC (permalink / raw)
  To: devel; +Cc: Valentin Gagarin

Also point first readers to the contributing page, not the page with
communication channels.

This adds a Jekyll plugin for annotating redirects, such that links
never have to break when source files are moved.

Signed-off-by: Valentin Gagarin <valentin@gagarin.work>
---
 Documentation/Gemfile                     |  2 +
 Documentation/Gemfile.lock                |  3 +
 Documentation/README                      |  6 --
 Documentation/_config.yml                 |  1 +
 Documentation/contributing.html           | 91 -----------------------
 Documentation/doc/contributing/index.adoc |  1 +
 Documentation/gemset.nix                  | 11 +++
 Documentation/index.html                  |  7 +-
 8 files changed, 22 insertions(+), 100 deletions(-)
 delete mode 100644 Documentation/contributing.html

diff --git a/Documentation/Gemfile b/Documentation/Gemfile
index a6396da..7de564a 100644
--- a/Documentation/Gemfile
+++ b/Documentation/Gemfile
@@ -6,3 +6,5 @@ source "https://rubygems.org"
 
 gem "jekyll"
 gem "jekyll-asciidoc"
+
+gem "jekyll-redirect-from"
diff --git a/Documentation/Gemfile.lock b/Documentation/Gemfile.lock
index 992e6da..03d4f60 100644
--- a/Documentation/Gemfile.lock
+++ b/Documentation/Gemfile.lock
@@ -43,6 +43,8 @@ GEM
     jekyll-asciidoc (3.0.1)
       asciidoctor (>= 1.5.0, < 3.0.0)
       jekyll (>= 3.0.0)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (3.1.0)
       sass-embedded (~> 1.75)
     jekyll-watch (2.2.1)
@@ -81,6 +83,7 @@ PLATFORMS
 DEPENDENCIES
   jekyll
   jekyll-asciidoc
+  jekyll-redirect-from
 
 BUNDLED WITH
    2.7.2
diff --git a/Documentation/README b/Documentation/README
index bd02f12..f366637 100644
--- a/Documentation/README
+++ b/Documentation/README
@@ -1,12 +1,6 @@
 These files contain the static portion of the website accessible at
 <https://spectrum-os.org/>.  Skit, Mailman, etc, are run separately.
 
-If you would like to contribute to the Spectrum operating system itself, please
-refer to the contributing.html file.
-
-If you'd like to contribute to the documentation,
-see building-documentation.adoc for how to get started.
-
 Design tweaks, content updates, fixes (both factual and grammatical),
 and new content for the Spectrum website are all welcomed.
 
diff --git a/Documentation/_config.yml b/Documentation/_config.yml
index cc3e8ea..a0623c4 100644
--- a/Documentation/_config.yml
+++ b/Documentation/_config.yml
@@ -4,6 +4,7 @@
 title: Spectrum documentation
 plugins:
   - jekyll-asciidoc
+  - jekyll-redirect-from
 exclude:
   - '*.license'
   - '*.nix'
diff --git a/Documentation/contributing.html b/Documentation/contributing.html
deleted file mode 100644
index 9bb21d8..0000000
--- a/Documentation/contributing.html
+++ /dev/null
@@ -1,91 +0,0 @@
----
-layout: page
-title: Contributing to Spectrum
-nav_order: 10
----
-<!-- SPDX-FileCopyrightText: 2019-2020, 2022 Alyssa Ross <hi@alyssa.is> -->
-<!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later -->
-<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
-
-<p>
-Thank you so much for your interest in contributing to Spectrum.
-Having a healthy community of people who feel empowered to work on the
-project is vital to its success.  To that end, if you have any
-questions about contributing to the project,
-please <a href="/doc/contributing/communication.html">get in touch</a>
-with the community, and we'll gladly help you out!
-
-<h2>Contributing code</h2>
-
-<p>
-If you're interested in contributing code to Spectrum, you
-can <a href="https://spectrum-os.org/git/">find</a> the source
-repositories online.
-
-If you've made changes you'd like to be included in the official
-Spectrum distribution, please send patches to the
-spectrum-devel <a href="https://lists.spectrum-os.org/mailman3/lists/devel.spectrum-os.org/">
-mailing list</a>
-(<a href="mailto:devel@spectrum-os.org">devel@spectrum-os.org</a>).
-
-<p>
-<strong>DON'T PANIC.</strong>
-
-<p>
-Sending patches to the list is easy — you can do it with Git, straight
-from the command line.  <strong>You don't have to set anything up in
-your email client</strong>, and <strong>you don't have to subscribe to
-the list</strong>.  The only thing you need to do is probably to set
-up Git so it knows how to send email using your provider's SMTP
-server.  These <a href="https://git-send-email.io/">instructions</a>
-should be enough to get you going, but if you're still stuck, send an
-email
-to <a href="mailto:devel@spectrum-os.org">devel@spectrum-os.org</a>
-and we'll help you out.
-
-<p>
-Once you have Git configured correctly, sending your changes to the
-list should be as simple as something like
-
-<pre>
-git send-email origin/master --to devel@spectrum-os.org
-</pre>
-
-<p>
-You'll be CCed on replies to your posts, so you don't even have to be
-subscribed to the mailing list if you're worried about too much
-traffic.  There's also
-a <a href="https://lists.spectrum-os.org/hyperkitty">web interface</a>
-that you can use to browse or even post to the mailing list.
-
-<p>
-Please add a Signed-off-by line to each patch you submit, to indicate
-your certification of
-the <a href="https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt">Developer's
-Certificate of Origin</a> for that patch.  The easiest way to do this
-is with <code>git commit</code>'s <code>-s</code> flag.
-
-<p>
-Don't be too afraid of getting it wrong the first couple of times.
-This might well be a new way of collaborating for you, and everybody
-understands that.  Hopefully, you'll soon realise just how effective
-this style of collaboration can be compared to the alternatives.
-
-<h2>Contributing other things</h2>
-
-<p>
-At this early stage, it's difficult to say what things would be useful
-to the project beyond code.  Artwork and documentation will be
-extremely important and valuable, but we don't yet have a good place
-to keep / use them.  But, don't let that dissuade you!  At some point
-we'll need all sorts of things, and we might as well get the work done
-early if people are willing to do it.
-
-<p>
-If you think you have skills to offer the project beyond writing code,
-we'd love to hear from you.  The best thing to do is to either talk
-with us
-on <a href="/doc/contributing/communication.html#spectrum-discuss">spectrum-discuss</a>,
-or in real time
-on <a href="/doc/contributing/communication.html#chat">Matrix or
-IRC</a>.
diff --git a/Documentation/doc/contributing/index.adoc b/Documentation/doc/contributing/index.adoc
index 04ff34a..c34f4c1 100644
--- a/Documentation/doc/contributing/index.adoc
+++ b/Documentation/doc/contributing/index.adoc
@@ -1,5 +1,6 @@
 = Contributing
 :page-nav_order: 5
+:page-redirect_from: ["/contributing.html"]
 
 // SPDX-FileCopyrightText: 2023 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/gemset.nix b/Documentation/gemset.nix
index b31a35e..a28cf9f 100644
--- a/Documentation/gemset.nix
+++ b/Documentation/gemset.nix
@@ -165,6 +165,17 @@
     };
     version = "3.0.1";
   };
+  jekyll-redirect-from = {
+    dependencies = ["jekyll"];
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "1nz6kd6qsa160lmjmls4zgx7fwcpp8ac07mpzy80z6zgd7jwldb6";
+      type = "gem";
+    };
+    version = "0.16.0";
+  };
   jekyll-sass-converter = {
     dependencies = ["sass-embedded"];
     groups = ["default"];
diff --git a/Documentation/index.html b/Documentation/index.html
index 5ce078c..c88cf79 100644
--- a/Documentation/index.html
+++ b/Documentation/index.html
@@ -4,9 +4,10 @@ title: Spectrum, a step towards usable secure computing
 no_heading: true
 nav_order: 0
 ---
-<!-- SPDX-FileCopyrightText: 2019-2020, 2022, 2024 Alyssa Ross <hi@alyssa.is> -->
 <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later -->
 <!-- SPDX-License-Identifier: GPL-3.0-or-later -->
+<!-- SPDX-FileCopyrightText: 2019-2020, 2022, 2024 Alyssa Ross <hi@alyssa.is> -->
+<!-- SPDX-FileCopyrightText: 2026 Valentin Gagarin <valentin@gagarin.work> -->
 
 <a href="logo" style="float: left; margin: 0 1em 0.5em 0">
   <img class="logo" src="logo/logo_html.svg" width="70" height="70" alt="Spectrum logo">
@@ -47,7 +48,7 @@ desktop systems.
 <p>
 Spectrum is free software, currently under active development.  If you
 are interested
-in <a href="/doc/contributing/communication.html">participating</a>,
+in <a href="/doc/contributing/index.html">contributing</a>,
 we'd love to have you.
 
 <h2>Funding</h2>
@@ -91,7 +92,7 @@ initiative by the Digital Single Market of the European Commission.
     and mailing lists</a>
     <li><a href="https://spectrum-os.org/git">Git repositories</a>
     <li><a href="doc/">Documentation</a>
-    <li><a href="contributing.html">Contributing to Spectrum</a>
+    <li><a href="doc/contributing/index.html">Contributing to Spectrum</a>
     <li><a href="https://pad.lassul.us/s/mDfFPvHjA">Bugs and upcoming projects</a>
     <li><a href="https://cryptpad.fr/kanban/#/2/kanban/view/yLtGXWLV6U7X5+Z1ay+oXKZMrSacqQe+51nXZYRh3ck/">Upstream bug/patch tracking</a>
   </ul>
-- 
2.54.0


^ permalink raw reply related	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2026-07-21 15:50 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-07  8:58 [PATCH] Documentation: remove redundant contributing page Valentin Gagarin
2026-07-10 13:55 ` Alyssa Ross
2026-07-10 15:58   ` Valentin Gagarin
2026-07-21 15:13     ` Alyssa Ross
2026-07-12 15:08 ` [PATCH v2] " Valentin Gagarin
2026-07-21 15:50   ` Alyssa Ross

Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock

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).