https://github.com/folio-org/docs
FOLIO Documentation
https://github.com/folio-org/docs
Last synced: about 1 year ago
JSON representation
FOLIO Documentation
- Host: GitHub
- URL: https://github.com/folio-org/docs
- Owner: folio-org
- License: apache-2.0
- Created: 2020-07-09T17:28:16.000Z (almost 6 years ago)
- Default Branch: ramsons
- Last Pushed: 2025-01-27T18:46:21.000Z (over 1 year ago)
- Last Synced: 2025-02-09T15:42:03.130Z (over 1 year ago)
- Language: HTML
- Homepage: https://docs.folio.org/
- Size: 4.91 MB
- Stars: 9
- Watchers: 12
- Forks: 34
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# FOLIO Documentation
Copyright (C) 2017-2024 The Open Library Foundation
This software is distributed under the terms of the Apache License,
Version 2.0. See the file "[LICENSE](LICENSE)" for more information.
## Introduction
This is the documentation for FOLIO apps.
If working with this Hugo site locally, be sure to execute
```
git submodule update --init --recursive
```
before attempting to build with Hugo for the first time.
### Serve with Docker
One way to locally serve the site is with Docker
1. [Install Docker for your operating system](https://docs.docker.com/get-docker/)
2. From the docs directory, run
```
docker run --rm -it -v $(pwd):/src -p 1313:1313 klakegg/hugo:ext-alpine server
```
### Serve locally with Hugo
Another option is to run Hugo locally on your computer
1. [Install Hugo for your operating system](https://gohugo.io/getting-started/installing)
2. From the docs directory, run
```
hugo server -D
```
### Preview the Docs site
After serving, visit
## FOLIO Documentation Working Group
Community members who are interested in helping with documentation should reach out to a member of the FOLIO Documentation Working Group to find out how you can help.
For questions regarding documentation, please join the
[slack channel](https://folio-org.atlassian.net/wiki/spaces/COMMUNITY/pages/4227287/FOLIO+Communication+Spaces#FOLIOCommunicationSpaces-slackSlack)
#folio-documentation and ask there.
Please refer to the
[FOLIO Documentation Working Group webspace](https://folio-org.atlassian.net/wiki/spaces/SS/pages/4489616/FOLIO+Documentation+Working+Group)
that includes the
[Basic Workflow in Github for Updating Existing Documentation](https://folio-org.atlassian.net/wiki/spaces/SS/pages/4490218/Basic+Workflow+in+Github+for+Updating+Existing+Documentation).
## Issue tracker
See project [DOCS](https://issues.folio.org/browse/DOCS)
at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).