Skip to content
Snippets Groups Projects
Commit 0254e6e6 authored by Jérémy Bobbio (Lunar)'s avatar Jérémy Bobbio (Lunar)
Browse files

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
parent 1caa6498
No related branches found
No related tags found
No related merge requests found
Pipeline #1134 passed
docs/README.rst
\ No newline at end of file
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**
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**
../README.rst
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment