The following inconsistencies between the documentation and the user interface of the application were found while reviewing the article MANAGING YOUR COLLECTION’S SETTINGS. The principle is to write all UI terms exactly as they appear in the application.
[x] Line 9: Step 2: Navigate to the Settings area and click AccountsAccount.
[x] Line 17: Step 2: You will receive an email from the no-reply@uwazi.io account. Follow the instructions. -> The email comes from uwazi@uwazi.uwazi.io
[x] Line 29: Step 2: Navigate to the Settings area and click AccountsAccount.
[x] Line 31: Step 3: You will see Two-Step VerificationTwo-Factor Authentication, click on Protect Your AccountEnable.
[x] Line 35: Step 5: Enter the code and click ConfirmEnable. If you have successfully enabled two-factor authentication, your account settings will reflect this.
[x] Line 53: - Adminadmin role has the ability to create, see and edit all Entities; change all settings throughout the Uwazi instance; and add new users
[x] Line 54: Editoreditor role has the ability to create, see and edit all Entities
[x] Line 55: - Collaboratorcollaborator role has the ability to create new Entities and can be invited to see and edit other others on an individual basis
[x] Line 59: Step 1: Only an Adminadmin can create new users. Navigate to the Settings area and click UsersUsers & Groups.
[x] Line 63: Step 3: You can create new users by clicking the Add UserAdd user button at the bottom. Here, you can also edit or delete users, as necessary.
[x] Line 65: Step 4: Enter a username, their email address and select a role (Adminadmin,Editoreditor or Collaboratorcollaborator ) for them.
[x] Line 71: Step 1: Only an Adminadmin can create new users. Navigate to the Settings area and click UsersUsers & Groups.
[x] Line 75: Step 3: You can create new groups by clicking the Add GroupAdd group button at the bottom. Here, you can also edit or delete users in that group, as necessary.
[x] Line 77: Step 4: Assign a Name of the groupName for the new group and add the usernames that you want to include as members for the group.
[x] Line 87: The name is "Uwazi" by default default Collection Name is "Uwazi", but you can change it to anything you like.
[x] Line 95: Step 2: On the left sidebar under Tools, click on Uploads. Select Then Import assetBrowse Files to Upload and upload the image that you converted to the .ico format. Once your image uploads, copy the URL. (It will begin with /assets)
[x] Line 97: Step 3: Navigate back to the Collection area under Settingsarea. Under Custom Favicon, toggle the option on and paste the above URL. Paste the previously copied URL into the field Custom Favicon.
[x] Line 105: However, you can set any page from within your Uwazi instance to act as the landing page instead. Toggle on the option to Use Custom Landing Page and paste the relative URL in the box. Paste the relative URL in the field Custom landing page. A relative URL starts with a slash / and skips the domain name. For example:
[x] Line 109: - A An Entity: /entity/9htbkgpkyy7j5rk9
[x] Line 119: ### Make your collection private (or public) -> rewrite the whole section
Make your collection public (or private)
Your collection is by default private. This means that your information will not be crawled by search engines, and visitors will be prompted with a login screen when trying to access any part of your collection: the Library, individual Entities, the landing page, etc. If you are handling sensitive information or you just want your collection to be accessible only to users with login credentials, keep the default setting. If you want to make your collection public and accessible to anyone, activate the option Public instance. You can always turn your collection back to private by disabling this option.
[x] Line 127: Cookies are bits of information used by some websites you visit and stored on your computer’s hard drive. Uwazi uses cookies to deliver an optimal experience for users and visitors alike. If you would like to display a notification about the use of cookies upon first visit to your instance, toggle on activate the option Show Cookie PolicyShow cookie policy.
[x] Line 149: Step 3: Toggle on the option for Google Analytics or Matomo Analytics, depending on your preference, and add the unique ID. Click the Save button. Add your Google Analytics or Matomo Analytic unique ID to the corresponding field and click the Save button.
[x] Line 157: - This is a JSON configuration object that should match the options values required by Nodemailer. as explained here.
[x] Line 159: - This setting takes precedence over all other mailer configuration. If left blank, then the configuration file in /api/config/mailer.js/api/config/mailer.js will be used.
[x] Line 163: If you have added a Contact Form to a custom Page within your collection, you must set the email address that receives the information from that form. Learn more about adding PagesLearn more about adding Pages to your collection.
[x] Line 165: Step 1: Navigate to the Settings area and click on collectionCollection in the left sidebar.
[x] Line 167: Step 2: Toggle on the option of Contact Form and set the Receiving Email address. Provide in the field Contact form email an email address that will receive the form's submissions.
[x] Line 169: Step 3: You can also set a different address as the Sending EmailSending email. This email address will appear as the sender of emails associated with the contact form. If no email address is set, no-reply@uwazi.io will be used. -> is no-reply@uwazi.io the correct address???
[ ] Line 173: The description in the section ### Submission form configuration does not fit to the UI -> what is the right description here???
[x] Line 197: Step 2: Under MapsMap, you can change the map provider for your collection.
[x] Line 201: - Detailed guidelines on how to set up a Google Maps API key can be found here -> link is missing
[x] Line 221: - How many types of users (Admin, Editor, CollaboratorAdmins, Editors, Collaborators) your collection has
The following inconsistencies between the documentation and the user interface of the application were found while reviewing the article MANAGING YOUR COLLECTION’S SETTINGS. The principle is to write all UI terms exactly as they appear in the application.
AccountsAccount.AccountsAccount.Two-Step VerificationTwo-Factor Authentication, click onProtect Your AccountEnable.ConfirmEnable. If you have successfully enabled two-factor authentication, your account settings will reflect this.Adminadmin role has the ability to create, see and edit all Entities; change all settings throughout the Uwazi instance; and add new usersEditoreditor role has the ability to create, see and edit all EntitiesCollaboratorcollaborator role has the ability to create new Entities and can be invited to see and editotherothers on an individual basisAdminadmin can create new users. Navigate to the Settings area and clickUsersUsers & Groups.Add UserAdd user button at the bottom. Here, you can also edit or delete users, as necessary.Adminadmin,Editoreditor orCollaboratorcollaborator ) for them.Adminadmin can create new users. Navigate to the Settings area and clickUsersUsers & Groups.Add GroupAdd group button at the bottom. Here, you can also edit or delete users in that group, as necessary.Name of the groupName for the new group and add the usernames that you want to include as members for the group.name is "Uwazi" by defaultdefault Collection Name is "Uwazi", but you can change it to anything you like.SelectThen Import assetBrowse Files to Uploadand upload the image that you converted to the .ico format. Once your image uploads, copy the URL. (It will begin with/assets
)area.Under Custom Favicon, toggle the option on and paste the above URL.Paste the previously copied URL into the field Custom Favicon.Toggle on the option to Use Custom Landing Page and paste the relative URL in the box.Paste the relative URL in the field Custom landing page. A relative URL starts with a slash/
and skips the domain name. For example:AAn Entity:/entity/9htbkgpkyy7j5rk9
toggle onactivate the optionShow Cookie PolicyShow cookie policy.Toggle on the option for Google Analytics or Matomo Analytics, depending on your preference, and add the unique ID. Click the Save button.Add your Google Analytics or Matomo Analytic unique ID to the corresponding field and click the Save button.as explained here./api/config/mailer.js/api/config/mailer.js
will be used.Learn more about adding PagesLearn more about adding Pages to your collection.collectionCollection in the left sidebar.Toggle on the option of Contact Form and set the Receiving Email address.Provide in the field Contact form email an email address that will receive the form's submissions.Sending EmailSending email. This email address will appear as the sender of emails associated with the contact form. If no email address is set, no-reply@uwazi.io will be used. -> is no-reply@uwazi.io the correct address???MapsMap, you can change the map provider for your collection.Admin, Editor, CollaboratorAdmins, Editors, Collaborators) your collection has