From 3716163848e0e3e2530fb35e15ca945fcc86e4c6 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:53:54 +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      | 34 +++++++++++++++++++++++++++++++++-
 docs/README.rst | 34 +---------------------------------
 2 files changed, 34 insertions(+), 34 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..4bd3d2c
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,33 @@
+Software Heritage - Authentication
+==================================
+
+``swh-auth`` is a set of utility libraries related to user authentication
+in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_.
+
+`Keycloak`_ is an open source software enabling single sign-on (SSO) with identity
+and access management.
+
+`OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely
+used in modern web applications and services.
+
+``swh-auth`` notably offers the following features:
+
+- the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the
+  interaction with a Keycloak server
+
+- a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak
+  responses in unit tests
+
+- generic backends, views and middlewares to easily plug OpenID Connect authentication
+  in any `Django`_ or `Django REST framework`_ application
+
+
+.. _Keycloak: https://www.keycloak.org/
+
+.. _OpenID Connect: https://openid.net/connect/
+
+.. _OAuth 2.0: https://oauth.net/2/
+
+.. _Django: https://www.djangoproject.com/
+
+.. _Django REST framework: https://www.django-rest-framework.org/
\ No newline at end of file
diff --git a/docs/README.rst b/docs/README.rst
deleted file mode 100644
index 4bd3d2c..0000000
--- a/docs/README.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-Software Heritage - Authentication
-==================================
-
-``swh-auth`` is a set of utility libraries related to user authentication
-in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_.
-
-`Keycloak`_ is an open source software enabling single sign-on (SSO) with identity
-and access management.
-
-`OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely
-used in modern web applications and services.
-
-``swh-auth`` notably offers the following features:
-
-- the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the
-  interaction with a Keycloak server
-
-- a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak
-  responses in unit tests
-
-- generic backends, views and middlewares to easily plug OpenID Connect authentication
-  in any `Django`_ or `Django REST framework`_ application
-
-
-.. _Keycloak: https://www.keycloak.org/
-
-.. _OpenID Connect: https://openid.net/connect/
-
-.. _OAuth 2.0: https://oauth.net/2/
-
-.. _Django: https://www.djangoproject.com/
-
-.. _Django REST framework: https://www.django-rest-framework.org/
\ No newline at end of file
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