Resources/Documentation/Contribute - Revision history

Samason: /* Questions? */

2025-07-03T13:03:53Z

‎Questions?

Samason: /* Suggest minor fixes to Artefactual */

2025-07-03T13:00:56Z

‎Suggest minor fixes to Artefactual

Samason: /* Suggest minor fixes to Artefactual */

2025-07-03T13:00:19Z

‎Suggest minor fixes to Artefactual

Hansarno: /* Suggest minor fixes to Artefactual */

2025-07-03T11:37:40Z

‎Suggest minor fixes to Artefactual

Hansarno: /* Suggest minor fixes to Artefactual */

2025-07-03T11:34:56Z

‎Suggest minor fixes to Artefactual

Dan: /* Contribute documentation translations */ Update links to point to Weblate, not Transifex

2024-03-28T12:17:31Z

‎Contribute documentation translations: Update links to point to Weblate, not Transifex

Dan: /* SSH keys - Mac and Linux users */ Fix docs link to use "latest" so it stays up to date

2019-05-16T15:50:52Z

‎SSH keys - Mac and Linux users: Fix docs link to use "latest" so it stays up to date

Crogers: /* SSH keys - Mac and Linux users */

2019-05-16T15:48:01Z

‎SSH keys - Mac and Linux users

Crogers at 15:46, 16 May 2019

2019-05-16T15:46:35Z

Dan: /* Text editor config - Mac/Linux */ update image names

2019-05-16T15:04:52Z

‎Text editor config - Mac/Linux: update image names

@@ Line 854: / Line 854: @@
 ==Questions?==
-If there's something that you're not clear about in these instructions, or you've run into an unexpected error, send us an email at [mailto:webmaster@artefactual.com webmaster@artefactual.com], or make a post in the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum]!
+If there's something that you're not clear about in these instructions, or you've run into an unexpected error, send us an email at [mailto:contributors@artefactual.com contributors@artefactual.com], or make a post in the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum]!
 <admonition type="seealso">

@@ Line 45: / Line 45: @@
 Please keep in mind that we have to prioritize our client assignments so that we can pay our bills and continue to provide free software and free community support.
-If you've submitted a suggestion for a fix to our documentation via [mailto:webmaster@accesstomemory.org webmaster@accesstomemory.org], thank you!
+If you've submitted a suggestion for a fix to our documentation via [mailto:contributors@artefactual.com contributors@artefactual.com], thank you!
 If it takes us a bit of time to implement a fix, it may be because we are currently focused on a client project - we will address any reported issues as soon as we are able.

@@ Line 36: / Line 36: @@
 See a typo or a broken link? Have a question or a minor suggestion? If you've noticed something that can be improved in our documentation, but don't have the time or resources to fix the problem yourself, we want to hear from you!
-'''Contact us at:''' [mailto:webmaster@accesstomemory.org webmaster@accesstomemory.org]
+'''Contact us at:''' [mailto:contributors@artefactual.com contributors@artefactual.com]
 <admonition type="important">

@@ Line 40: / Line 40: @@
 <admonition type="important">
 AtoM documentation is freely maintained by [https://www.artefactual.com Artefactual Systems], lead developers of the AtoM project.
 We do our best to ensure that our documentation is comprehensive, but as an open-source company that freely gives away software, documentation, and user support in our [https://groups.google.com/forum/#!forum/ica-atom-users User Forum].
 Please keep in mind that we have to prioritize our client assignments so that we can pay our bills and continue to provide free software and free community support.

@@ Line 39: / Line 39: @@
 <admonition type="important">
-AtoM documentation is freely maintained by [https://www.artefactual.com Artefactual Systems], lead developers of the AtoM project. We do our best to ensure that our documentation is comprehensive, but as an open-source company that freely gives away software, documentation, and user support in our [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], please keep in mind that we have to prioritize our client assignments so that we can pay our bills and continue to provide free software and free community support. If you've submitted a suggestion for a fix to our documentation via [mailto:webmaster@accesstomemory.org webmaster@accesstomemory.org], thank you! If it takes us a bit of time to implement a fix, it may be because we are currently focused on a client project - we will address any reported issues as soon as we are able. As always with open-source projects, the best way to ensure a fix is implemented is to contribute the fix yourself - we encourage our community users to become active contributors to all aspects of our projects.
+AtoM documentation is freely maintained by [https://www.artefactual.com Artefactual Systems], lead developers of the AtoM project.
 </admonition>

@@ Line 858: / Line 858: @@
 ==Contribute documentation translations==
-Want to help us translate these docs into your language? We rely on our amazing community volunteers to help us make AtoM a truly international application. Currently we are using [https://www.transifex.com/projects/p/atom/ Transifex] to help us manage our project translations.
+Want to help us translate these docs into your language? We rely on our amazing community volunteers to help us make AtoM a truly international application. Currently we are using [https://translations.artefactual.com/ Weblate] to help us manage our project translations.
 <admonition type="warning">
-This is still a work in progress! We hope to be able to add our documentation to Transifex in the future. In the meantime, we're always looking for help translating AtoM itself! See:  [[Resources/Translation|Contribute translations]]
+This is still a work in progress! We hope to be able to add our documentation to Weblate in the future. In the meantime, we're always looking for help translating AtoM itself! See:  [[Resources/Translation|Contribute translations]]
 </admonition>

@@ Line 309: / Line 309: @@
 '''Your process for starting up your Vagrant box - Mac and Linux users'''
-Open terminal and using your command line interface, navigate to the folder where you have initialized your [https://www.accesstomemory.org/en/docs/2.5/dev-manual/env/vagrant/#install-vagrant-and-virtualbox Vagrant box]. Check to see if your SSH key is loaded by typing <code>ssh-add -l</code>. If it is, you can now run <code>vagrant up</code>. If it is not, you can load it with <code>ssh add</code>, or if you have more than one SSH key, to ensure you load the right key, <code>ssh add ~/.ssh/id_rsa</code>, where "~/.ssh/id_rsa" is the file path to your SSH key.
+Open terminal and using your command line interface, navigate to the folder where you have initialized your [https://www.accesstomemory.org/docs/latest/dev-manual/env/vagrant/ Vagrant box]. Check to see if your SSH key is loaded by typing <code>ssh-add -l</code>. If it is, you can now run <code>vagrant up</code>. If it is not, you can load it with <code>ssh add</code>, or if you have more than one SSH key, to ensure you load the right key, <code>ssh add ~/.ssh/id_rsa</code>, where "~/.ssh/id_rsa" is the file path to your SSH key.
 When your key is loaded, run <code>vagrant up</code>, and then SSH into the Vagrant environment using your key with <code>vagrant ssh -- -A</code>. This will allow you to link to your github account.

@@ Line 311: / Line 311: @@
 Open terminal and using your command line interface, navigate to the folder where you have initialized your [https://www.accesstomemory.org/en/docs/2.5/dev-manual/env/vagrant/#install-vagrant-and-virtualbox Vagrant box]. Check to see if your SSH key is loaded by typing <code>ssh-add -l</code>. If it is, you can now run <code>vagrant up</code>. If it is not, you can load it with <code>ssh add</code>, or if you have more than one SSH key, to ensure you load the right key, <code>ssh add ~/.ssh/id_rsa</code>, where "~/.ssh/id_rsa" is the file path to your SSH key.
-When your key is loaded, run <cade>vagrant uop</code>, and then SSH into the Vagrant environment using your key with <code>vagrant ssh -- -A</code>. This will allow you to link to your github account.
+When your key is loaded, run <code>vagrant up</code>, and then SSH into the Vagrant environment using your key with <code>vagrant ssh -- -A</code>. This will allow you to link to your github account.
 <admonition type="note">

@@ Line 307: / Line 307: @@
 Keep a password-protected copy of your key somewhere secure on your local computer. Make sure the private key password is unique and secure!
-'''Your process for starting up your Vagrant box'''
+'''Your process for starting up your Vagrant box - Mac and Linux users'''
-Using your command line interface, navigate to the folder where you have initialized your Vagrant box. Check to see if your SSH key is loaded by typing <code>ssh-add -l</code>. If it is, you can now run <code>vagrant up</code>. If it is not, you can load it with <code>ssh add</code>, or if you have more than one SSH key, to ensure you load the right key, <code>ssh add ~/.ssh/id_rsa</code>, where "~/.ssh/id_rsa" is the file path to your SSH key.
+Open terminal and using your command line interface, navigate to the folder where you have initialized your [https://www.accesstomemory.org/en/docs/2.5/dev-manual/env/vagrant/#install-vagrant-and-virtualbox Vagrant box]. Check to see if your SSH key is loaded by typing <code>ssh-add -l</code>. If it is, you can now run <code>vagrant up</code>. If it is not, you can load it with <code>ssh add</code>, or if you have more than one SSH key, to ensure you load the right key, <code>ssh add ~/.ssh/id_rsa</code>, where "~/.ssh/id_rsa" is the file path to your SSH key.
-When your key is loaded, you can run <code>vagrant ssh -- -A</code> to SSH into the Vagrant environment with your own key. This will allow you to link to your github account.
+When your key is loaded, run <cade>vagrant uop</code>, and then SSH into the Vagrant environment using your key with <code>vagrant ssh -- -A</code>. This will allow you to link to your github account.
 <admonition type="note">

@@ Line 558: / Line 558: @@
 </admonition>
-[[File:access-docs-locally.png|center|600px|thumb|An image of Spotlight on a Mac]]
+[[File:mac-access-docs-locally.png|center|600px|thumb|An image of Spotlight on a Mac]]
 Hit “enter” to connect. Choose “vagrant”. When asked for a username and password, type “vagrant” for both.
-[[File:connect.png|center|600px|thumb|Connect to your vagrant box]]
+[[File:mac-connect.png|center|600px|thumb|Connect to your vagrant box]]
 When your computer has successfully connected, you will see folders “atom” and “atom-docs”. Open your text editor (atom.io in this screenshot) and drag “atom-docs” into the editor.
-[[File:add-text-to-editor.png|center|600px|thumb|Add documents to your local text editor]]
+[[File:mac-add-text-to-editor.png|center|600px|thumb|Add documents to your local text editor]]
 You're ready to start making changes now!