Documentation updates

[CraigClark]

OP timer

https://openplus.monday.com/boards/4092908516/pulses/6200666243

---

There have been several changes since the documentation was written. It needs a full review and some sections need to be added.

[!IMPORTANT] Pay close attention to the use of the phrase data set. It has been used interchangeably with a lot of other terminology. Data set could refer to:

• Metadata record
• asset
• data, report or form

• [x] Review config vs content and update as needed
• [x] #177
• [x] Only authenticated users can access documentation (book content type) @lkmorlan
• [x] review creating MR
  • [x] add information on working with the new way of working with date modified
  • [x] review documentation for fields
  • [x] check for missing fields
  • [x] check for fields that have changed labels or other characteristics
  • [x] check for fields that have been removed from the data catalogue
  • [x] New section for editing MR
• [x] review review interval NEW: change this to info on reviews in general and include new IU for reviewing when there are no changes.
• [x] working with taxonomies should be in the admin section
• [x] add information for new Document type taxonomy
• [x] update org
• [x] update security classification (@NicoledeGreef)
• [x] add a section on API, most of the API docs are in the wiki, but we should have a view that lists all the IDs people might need for creating/editing records via the API
  • [x] include info on what dc admin has to do to set up accounts
• [x] add info to the wiki on setting values in the dc_module. Reference it from the documentation admin
• [x] new section on using the data catalogue
  • [x] saving searches
  • [x] exporting searches
  • [x] bookmarks
  • [x] notification
  • [x] dashboard overview
  • [x] reports
  • [x] who to contact for more help
• [x] in the wiki, document how to run the automated tests
• [x] using revisions

[CraigClark]

re:

add a section on API, most of the API docs are in the wiki, but we should have a view that lists all the IDs people might need for creating/editing records via the API

I talked to Joel about this. The best way is not a view, but to create a feed. Since MFIN has no plans at the moment to manage records via API, we will not be building the feed. I did mention in the documentation that one should be added when JSON API is used to create/update records.

[CraigClark]

for this _add info to the wiki on setting values in the dcmodule. Reference it from the documentation admin, I added the info to docs in the data catalogue instead. This is because #397 moves configuring the custom module to the UI where it can be managed by DC admins.

[CraigClark]

Bookmarks and notification will be rolled into the same doc because notification depends on a record being bookmarked.

[CraigClark]

'who to contact' is content added to the front page of the help guide.

[CraigClark]

docs for running tests are here https://github.com/bcgov/MFIN-Data-Catalogue/wiki/Test-plan

[CraigClark]

Assigning to @lkmorlan for Only authenticated users can access documentation (book content type)

Assigning to @NicoledeGreef for update security classification