| html_theme.sidebar_secondary.remove: |
|---|
Welcome to Software Heritage documentation
Discover Software Heritage
Why an universal software archive?
- A video to get to know Software Heritage
- Our mission
- Our approach
- The content of the archive at a glance
Software Heritage in practice
- Take a guided tour of the archive key features
- Overview of the main features
- Access and reuse the source code
- Good practices for archiving and referencing your code
- Get a permanent identifier for your source code
- General FAQ
- :ref:`Glossary <glossary>`
Archive source code
Before anything…
Save a code repository
- “Ready to go” options to save your code :
- Seamlessly check if a repository that you are browsing is archived and up to date using our Software Heritage browser extensions
- Submit a save request on the Software Heritage interface
- Automate the archival:
Save multiple projects at a time, save a forge
Save a forge in 2 steps :
:ref:`Technical insight on the “Add forge now” process <save-forge>`
Save code used for science
Save a software using ELife, Ipol, HAL. Your content are directly pushed into the archive by trusted partners using the deposit service of Software Heritage:
Save legacy source code
Recovering and curating landmark legacy source code : how to save legacy code
Search, browse and reference
- Take the guided tour of the archive web interface
- Good practices for archiving and referencing your code
- Make your code identifiable : get a PID for your source code
- Choosing what type of Software Hash Identifier (SWHID) to use
- Navigating through Software Heritage: behind the scenes
Need help? Want to make a proposal? Ask the community using the users mailing-list
Tell the world
Ambassador program
- Become an ambassador
- Ambassadors mailing list
- Outreach material (only available to ambassadors)
- Outreach material on a Git repository
Presentations
Use in your applications
Browse API
- Terms of use for Software Heritage API
- Web API. Access the API overview or discover the full endpoints index
Data model and identifiers
- Our data model
- :ref:`Software Hash IDentifiers (SWHID) <persistent-identifiers>` specifications
- Compute a SWHID locally using the swh identify command-line tool.
Deposit API
- :ref:`Import source code programmatically <deposit-user-manual>`
Improve the universal archive
- :ref:`Our roadmap <roadmap-current>`
- :ref:`Developer documentation <swh-docs-devel>`. Where you will find developer-oriented documentation to understand the SWH environment.
- Get started
Contributing development skills:
- :ref:`Software architecture overview <architecture-overview>`
- Developers portal
- Development mailing-list. Join the community
- :ref:`Development FAQ <faq>`
Contributing resources and infrastructure:
- :ref:`Mirror operations <mirror_operations>`