For questions regarding documentation, please join the slack channel #folio-documentation and ask there.
-----------------------
Where can you find FOLIO documentation?
FOLIO documentation consists of the following repositories and sites:
- https://docs.folio.org: This site is primarily for end user documentation with documentation for each released FOLIO version.It is accessible via folio.org, and is available via a Help icon in the FOLIO user interface.
- https://github.com/folio-org/docs: This repository provides version control for all of the content housed on docs.folio.org.
- https://issues.folio.org/secure/Dashboard.jspa: This site provides for workflow management of items related to documentation.
- FOLIO Individual Apps: Information, Tips and Tricks: This page has informal community-maintained documentation that is more robust.
Contributing to docs.folio.org
Docs.folio.org is maintained by members of the Documentation Working Group. Individual members are listed to the right, along with areas they are responsible for.
Basic workflows for how documentation is maintained are described under Resources for Docs WG members.
Anyone who wants to ask for improvement or addition to documentation should create a FOLIO jira ticket and assign it to the DOCS project.
If you are not sure who should work on the ticket so you don't know who to assign it to, please also leave a comment in the #documentation-wg Slack channel.
For resources for working group members in Jira, see Using Jira to manage work for docs.folio.org0ad7a2c9-e8c4-4f35-afe4-bdb26fd5e5f0
| Tip |
|---|
| Community members who are interested in helping with documentation should reach out to a member of the Working Group to find out how you can help. |
Future plans
Localization
Internationalization of the Hugo-based docs.folio site has been completed in 2020. A proof-of-concept for the German localization (= actual translation) is being stored on a separate branch (Branch/Pull Request, Preview) until such time that content is ready for inclusion and gets approved by the German translation team.
Context-sensitive Help
Future work should include a mechanism for users to click on an area of the user interface and open the relevant section of the documentation for help.
Working Group Membership
Area | Working Group Representative |
|---|---|
| Convenor | Katharina Jung |
Home/About | N/A |
Getting Started | N/A |
Gettings Started -> Installation | Ingolf Kuss |
Get to know FOLIO? | currently unassigned |
| Platform Essentials | currently unassigned |
Users | Christine Tobias |
RA/Circulation > Check out | Laurence Mini |
RA/Circulation > Check in | Laurence Mini |
RA/Circulation > Circulation Log | Laurence Mini |
RA/Circulation > Requests | Laurence Mini |
RA/Circulation > Courses | Laurence Mini |
RM/Acquisitions > Orders | Molly Driscoll |
RM/Acquisitions > Finance | Molly Driscoll |
RM/Acquisitions > Invoices | Molly Driscoll |
RM/Acquisitions > Receiving | Molly Driscoll |
RM/Acquisitions > Organizations | Molly Driscoll |
MM/Cataloging > Inventory | Kathy Peters / Lisa Lorenzo |
MM/Cataloging > MARCauthority | Kathy Peters / Lisa Lorenzo |
MM/Cataloging > Data export | Kathy Peters / Lisa Lorenzo |
MM/Cataloging > Data import | Kathy Peters / Lisa Lorenzo |
| Bulk edit | Amanda Ros (items, holdings), Christine Tobias (users) |
ERM > Agreements | Emma Raub |
ERM > Licenses | Emma Raub |
ERM > eHoldings | Emma Raub |
ERM > eUsage | Annika Schröer |
| Export manager | Molly Driscoll |
| Dashboard | |
| Reporting | Eliana Lima; Axel Dörrer, Sharon Beltaine, Alexander Chen Lao |
| Consortia | Lucy Harrison |
Settings | (Multiple) |
Glossary | (Multiple) |
| Liaison to Product Council | Martina Tumulla |