diff --git a/users/.gitignore b/users/.gitignore new file mode 100644 index 0000000..e76b2db --- /dev/null +++ b/users/.gitignore @@ -0,0 +1,4 @@ +*-stamp +_build/ +/swh-* +sources/ diff --git a/users/Makefile b/users/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/users/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/users/_static b/users/_static new file mode 120000 index 0000000..ead5849 --- /dev/null +++ b/users/_static @@ -0,0 +1 @@ +../docs/_static \ No newline at end of file diff --git a/users/conf.py b/users/conf.py new file mode 100644 index 0000000..159c2f0 --- /dev/null +++ b/users/conf.py @@ -0,0 +1,3 @@ +from swh.docs.sphinx.conf import * # noqa + +project = "Software Heritage - User Documentation" diff --git a/users/faq.rst b/users/faq.rst new file mode 100644 index 0000000..99dc2ed --- /dev/null +++ b/users/faq.rst @@ -0,0 +1,31 @@ +.. _faq: + +Frequently Asked Questions +========================== + +What file formats are supported with the save code now? +------------------------------------------------------- + +The save code now is intended publicly for code repositories with git, mercurial or svn +version control systems. For authenticated user with role ambassador, it is possible to +do save code now requests on zip or tarballs. + +I cannot find all my “releases” in a git repository archived in Software Heritage, what should I do? +---------------------------------------------------------------------------------------------------- + +Do not worry, the repository has been saved in full. What you are witnessing is just a +terminological difference between what platforms like GitHub calls “releases” (any non +annotated git tag) and what we call “releases” (a node in the Merkle tree, which +corresponds to a git annotated tag). Let’s say your “release” is FinalSubmission. If you +click on the branch dropdown menu on the Software Heritage Web interface you’ll find +what you are looking listed as “refs/tags/FinalSubmission”. If you want a “release” to +appear in our web interface you should create your tags using “git tag -a”, instead of +simply “git tag” (and then archive your repository again). + +Where can I find the SWH roadmap? +--------------------------------- + +The roadmap is accessible on the `docs +`__. + + diff --git a/users/index.rst b/users/index.rst new file mode 100644 index 0000000..2393186 --- /dev/null +++ b/users/index.rst @@ -0,0 +1,38 @@ +.. _swh-docs: + +.. Software Heritage documentation master file, created by + sphinx-quickstart on Thu Jun 17 11:23:12 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Software Heritage User documentation +==================================== + +Getting started +--------------- + +... + +Tutorials +--------- + +... + +* :ref:`faq` → Frequently Asked Questions + +Contents +-------- + + +.. toctree:: + :maxdepth: 1 + + faq + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/users/make.bat b/users/make.bat new file mode 100644 index 0000000..922152e --- /dev/null +++ b/users/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd