diff --git a/README.rst b/README.rst deleted file mode 120000 index cffceba7c58191d8215f5d98a17575ef3a50bc06..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..f9aee205a60ac6d0da6ec5a38beba4c5d728dee3 --- /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 f9aee205a60ac6d0da6ec5a38beba4c5d728dee3..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..89a0106941ff398844f23a965c5b755ca12eef97 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file