From 0254e6e686d4524acf8ee57570b40bdf190eee69 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio=20=28Lunar=29?=
 <lunar@softwareheritage.org>
Date: Thu, 23 Feb 2023 16:54:04 +0100
Subject: [PATCH] Invert symlink and content for the README file

GitLab will display the content of the README file when browsing the
repository. But in case the file is a symlink, it will display the
path pointed by the symlink. There is a 6 year old issue about this:
https://gitlab.com/gitlab-org/gitlab/-/issues/15093

We can workaround the issue by having the content at the root of the
repository and a symlink to this file in the `docs/` directory.

Tested in swh/devel/swh-py-template!27
---
 README.rst      | 16 +++++++++++++++-
 docs/README.rst | 16 +---------------
 2 files changed, 16 insertions(+), 16 deletions(-)
 mode change 120000 => 100644 README.rst
 mode change 100644 => 120000 docs/README.rst

diff --git a/README.rst b/README.rst
deleted file mode 120000
index cffceba..0000000
--- a/README.rst
+++ /dev/null
@@ -1 +0,0 @@
-docs/README.rst
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..f9aee20
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,15 @@
+Software Heritage - Vault
+=========================
+
+User-facing service that allows to retrieve parts of the archive as
+self-contained bundles (e.g., individual releases, entire repository snapshots,
+etc.)
+The creation of a bundle is called "cooking" a bundle.
+
+Architecture
+------------
+
+The vault is made of two main parts:
+
+1. a stateful RPC server called the **backend**
+2. Celery tasks, called **cookers**
diff --git a/docs/README.rst b/docs/README.rst
deleted file mode 100644
index f9aee20..0000000
--- a/docs/README.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-Software Heritage - Vault
-=========================
-
-User-facing service that allows to retrieve parts of the archive as
-self-contained bundles (e.g., individual releases, entire repository snapshots,
-etc.)
-The creation of a bundle is called "cooking" a bundle.
-
-Architecture
-------------
-
-The vault is made of two main parts:
-
-1. a stateful RPC server called the **backend**
-2. Celery tasks, called **cookers**
diff --git a/docs/README.rst b/docs/README.rst
new file mode 120000
index 0000000..89a0106
--- /dev/null
+++ b/docs/README.rst
@@ -0,0 +1 @@
+../README.rst
\ No newline at end of file
-- 
GitLab