diff --git a/docs/faq/index.rst b/docs/faq/index.rst index ea2c68a..8a0855c 100644 --- a/docs/faq/index.rst +++ b/docs/faq/index.rst @@ -1,11 +1,10 @@ .. _faq: Frequently Asked Questions ========================== .. toctree:: :maxdepth: 2 :titlesonly: faq - diff --git a/users/faq.rst b/users/faq.rst deleted file mode 100644 index 99dc2ed..0000000 --- a/users/faq.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _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/faq/faq.rst b/users/faq/faq.rst new file mode 100644 index 0000000..0cc4846 --- /dev/null +++ b/users/faq/faq.rst @@ -0,0 +1,77 @@ +.. _faq_roadmap: + +Roadmap +======= + +Where can I find the SWH roadmap? +--------------------------------- + +The roadmap is accessible on the `docs +`__. + +.. _faq_savecodenow: + +Save Code Now +============= + +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. + +Is there a license existence check (the one included in the source code)? +------------------------------------------------------------------------- + +No. + +How are Save code now requests handled? +--------------------------------------- + +`Save code now `__ requests on known forges +for origins are scheduled as soon as possible. Unknown origins are put in a moderation +queue waiting for human vetting (Ambassadors or staff). + +what file formats are supported with the save code now? +------------------------------------------------------- + +The "save code now" supports public code repositories with git, mercurial or svn version +control systems. Ambassadors, however can also deposits for a given origins multiple +artifacts (zip, tarballs). + +My "Save code now" request is stuck in pending status. what should I do? +------------------------------------------------------------------------ + +If the repository you want to save is already in the authorized list (e.g. GitLab, +GitHub, ...), the repositories will be saved without approval, so this should not last +more than a few hours. If it's not the case, requests should be approved within a few +days (minus French bank holidays), and loaded in a few hours. + +If your repository is still pending after this time, this is most likely a bug. `Get in +touch with us `__ to check +whether we are aware of this potential issue or are working on it. + +.. _faq_search: + +Search +====== + +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). + +How can I search the SWH archive? is it possible to search over metadata? +------------------------------------------------------------------------- + +At the moment searching is possible using the url of a repository, package or deposit +(a.k.a the origin of the source code). You can use the checkbox "search in metadata +(instead of URL)" to search over intrinsic metadata. diff --git a/docs/faq/index.rst b/users/faq/index.rst similarity index 99% copy from docs/faq/index.rst copy to users/faq/index.rst index ea2c68a..8a0855c 100644 --- a/docs/faq/index.rst +++ b/users/faq/index.rst @@ -1,11 +1,10 @@ .. _faq: Frequently Asked Questions ========================== .. toctree:: :maxdepth: 2 :titlesonly: faq - diff --git a/users/index.rst b/users/index.rst index 2393186..9b2170b 100644 --- a/users/index.rst +++ b/users/index.rst @@ -1,38 +1,43 @@ .. _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 +Frequently Asked Questions +--------------------------- -Contents --------- +* :ref:`faq_savecodenow` Save Code Now related questions +* :ref:`faq_search` Search questions +* :ref:`faq_roadmap` Roadmap -.. toctree:: - :maxdepth: 1 - - faq - Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :titlesonly: + :hidden: + + faq/index