Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the README #1870

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 64 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,64 @@ By [Artefactual]
[![GitHub CI]][Test workflow]
[![codecov]][Archivematica Codecov]

Archivematica is a web- and standards-based, open-source application
which allows your institution to preserve long-term access to
trustworthy, authentic and reliable digital content. Our target users
are archivists, librarians, and anyone working to preserve digital
objects.
Archivematica is a web- and standards-based, open-source application which
allows your institution to preserve long-term access to trustworthy,
authentic and reliable digital content.
Our target users are archivists, librarians, and anyone working to preserve
digital objects.

You are free to copy, modify, and distribute Archivematica with
attribution under the terms of the AGPLv3 license. See the [LICENSE]
file for details.
You are free to copy, modify, and distribute Archivematica with attribution
under the terms of the AGPLv3 license.
See the [LICENSE] file for details.

## Installation

* [Production installation]
* [Development installation]

## Other resources
## Using Archivematica

* [Website][Archivematica]: User and administrator documentation
* [Wiki]: Developer facing documentation, requirements analysis and
community resources
* [Issues]: Git repository used for tracking Archivematica issues and
feature/enhancement ideas
* [User Google Group]: Forum/mailing list for user questions (both
technical and end-user)
* [Paid support]: Paid support, hosting, training, consulting and
software development contracts from Artefactual
* [Website] for the user and administrator documentation
* [Presentations repo] and [YouTube channel] for previous trainings and talks
* [User Group] is a forum/mailing list for user questions (both
technical and end-user)
* [Paid support] is for paid support, hosting, training, consulting
and software development contracts from Artefactual

## Developing with Archivematica

* [Archivematica API documentation] for getting to know the Archivematica API
* [Developer guide] is the developer facing documentation, requirements
analysis and community resources
* [Issues] is the Git repository used for tracking Archivematica issues
and feature/enhancement ideas

## Contributing

Thank you for your interest in Archivematica!
For more details, see the [contributing guidelines]

For more details, see the [contributing guidelines].

Read about our [merging process], including branch naming conventions, and
make any [documentation update] reflecting the changes introduced by your
contribution.

You might have questions about the history of developement decisions: find
answers in the [Architectural Decisions Record].

The [Wiki] currently holds the release notes and previous developer facing
documentation.

## Reporting an issue

Issues related to Archivematica, the Storage Service, or any related
repository can be filed in the [Archivematica Issues repository].
repository can be filed in the [Issues] repository.

### Security

If you have a security concern about Archivematica or any related
repository, please see the [SECURITY file] for information about how
to safely report vulnerabilities.
If you have a security concern about Archivematica or any related repository,
please see the [SECURITY file] for information about how to
safely report vulnerabilities.

## Related projects

Expand All @@ -55,31 +71,39 @@ Archivematica consists of several projects working together, including:
* [Archivematica][Archivematica GitHub]: This repository! Main
repository containing the user-facing dashboard, task manager
MCPServer and clients scripts for the MCPClient
* [Storage Service]: Responsible for moving files to Archivematica for
* [Storage Service] : Responsible for moving files to Archivematica for
processing, and from Archivematica into long-term storage
* [Format Policy Registry]: Submodule shared between Archivematica and
the Format Policy Registry (FPR) server that displays and updates
FPR rules and commands
* [Format Policy Registry] : Submodule shared between Archivematica and
the Format Policy Registry (FPR) server that displays and updates FPR
rules and commands

For more projects in the Archivematica ecosystem, see the [getting started] page.
For more projects in the Archivematica ecosystem,
see the [getting started] page.

[Architectural Decisions Record]: https://adr.archivematica.org/
[Archivematica API documentation]: https://archivematica.org/docs/latest/dev-manual/api/api-reference-archivematica/#api-reference-archivematica
[Archivematica Codecov]: https://codecov.io/gh/artefactual/archivematica
[Archivematica GitHub]: https://github.com/artefactual/archivematica
[Archivematica]: https://www.archivematica.org/
[Artefactual]: https://www.artefactual.com/
[GitHub CI]: https://github.com/artefactual/archivematica/actions/workflows/test.yml/badge.svg
[Test workflow]: https://github.com/artefactual/archivematica/actions/workflows/test.yml
[codecov]: https://codecov.io/gh/artefactual/archivematica/branch/qa/1.x/graph/badge.svg?token=tKlfjhmrlC
[Archivematica Codecov]: https://codecov.io/gh/artefactual/archivematica
[LICENSE]: LICENSE
[Production installation]: https://www.archivematica.org/docs/latest/admin-manual/installation-setup/installation/installation/
[contributing guidelines]: https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md
[Developer guide]: https://github.com/artefactual/archivematica/blob/qa/1.x/hack/README.md
[Development installation]: https://github.com/artefactual/archivematica/tree/qa/1.x/hack
[Wiki]: https://www.archivematica.org/wiki/Development
[documentation update]: https://github.com/artefactual/archivematica-docs/wiki
[Format Policy Registry]: https://github.com/artefactual/archivematica/tree/qa/1.x/src/dashboard/src/fpr
[getting started]: https://wiki.archivematica.org/Getting_started#Projects
[GitHub CI]: https://github.com/artefactual/archivematica/actions/workflows/test.yml/badge.svg
[Issues]: https://github.com/archivematica/Issues
[User Google Group]: https://groups.google.com/forum/#!forum/archivematica
[LICENSE]: LICENSE
[merging process]: https://wiki.archivematica.org/Merging
[Paid support]: https://www.artefactual.com/services/
[contributing guidelines]: CONTRIBUTING.md
[Archivematica Issues repository]: https://github.com/archivematica/Issues/issues
[Production installation]: https://www.archivematica.org/docs/latest/admin-manual/installation-setup/installation/installation/
[SECURITY file]: SECURITY.md
[Archivematica GitHub]: https://github.com/artefactual/archivematica
[Presentations repo]: https://slideshare.net/Archivematica/presentations
[Storage Service]: https://github.com/artefactual/archivematica-storage-service
[Format Policy Registry]: https://github.com/artefactual/archivematica/tree/qa/1.x/src/dashboard/src/fpr
[getting started]: https://wiki.archivematica.org/Getting_started#Projects
[Test workflow]: https://github.com/artefactual/archivematica/actions/workflows/test.yml
[User Group]: https://groups.google.com/forum/#!forum/archivematica
[Website]: https://www.archivematica.org/
[Wiki]: https://www.archivematica.org/wiki/Development
[YouTube channel]: https://www.youtube.com/@ArtefactualSystems