Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Islandora 8" audit #2084

Merged
merged 23 commits into from
Apr 13, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/contributing/editing-docs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Editing Documentation

## Overview
These documentation pages are written and maintained by volunteers from the Islandora community, and new contributions are always welcomed. The documentation that you see here is formatted in the easy to use [MarkDown](http://en.wikipedia.org/wiki/Markdown) markup language, which can add formatting such as links, headings, and bolded text. Then the documentation HTML site is built using [mkdocs](https://www.mkdocs.org/) from the MarkDown files hosted in the Islandora [documentation](https://github.com/Islandora/documentation) GitHub repo. This documentation is rebuilt automatically upon changes being committed to GitHub, so you will see changes reflected here within a few minutes of making an edit.
These documentation pages are written and maintained by volunteers from the Islandora community, and new contributions are always welcomed. The documentation that you see here is formatted in the easy-to-use [MarkDown](http://en.wikipedia.org/wiki/Markdown) markup language, which can add formatting such as links, headings, and bolded text. Then the documentation HTML site is built using [mkdocs](https://www.mkdocs.org/) from the MarkDown files hosted in the Islandora [documentation](https://github.com/Islandora/documentation) GitHub repo. This documentation is rebuilt automatically upon changes being committed to GitHub, so you will see changes reflected here within a few minutes of making an edit.

The [Islandora Documentation Interest Group](https://github.com/islandora-interest-groups/Islandora-Documentation-Interest-Group) holds regular meetings to discuss how to improve and expand Islandora's documentation. If you are interested in becoming involved, all are welcome to join. If you just want to make a contribution to the existing documentation, that process is outlined here.

Expand All @@ -10,15 +10,17 @@ The [Islandora Documentation Interest Group](https://github.com/islandora-intere
To edit documentation in Islandora, you must:

- have a [GitHub](https://github.com/) account.
- NOTE: Github accounts are free and only require a valid email address.
- have a very basic familiarity with GitHub terms such as [fork](https://guides.github.com/activities/forking/), [branch](https://guides.github.com/activities/hello-world/#branch), and [pull request](https://guides.github.com/activities/hello-world/#pr).
- be a member of the Islandora [GitHub Organization](https://github.com/orgs/Islandora/people).
- This is only needed if you want to commit changes directly to the documentation. Non-members may still make pull requests. To request an invite, email community@islandora.ca or ask on the Islandora Slack.
- have a basic familiarity with [Markdown](http://en.wikipedia.org/wiki/Markdown), or a good [MarkDown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
- Github accounts are free and only require a valid email address.
- have a very basic familiarity with Git terms such as [fork](https://guides.github.com/activities/forking/), [branch](https://guides.github.com/activities/hello-world/#branch), and [pull request](https://guides.github.com/activities/hello-world/#pr).
- optionally, be a member of the Islandora [GitHub Organization](https://github.com/orgs/Islandora/people).
- To request an invite, email community@islandora.ca or ask on the Islandora Slack.
- This is only needed if you want to commit changes directly to the documentation. Non-members may still make pull requests.
- be willing to learn with [Markdown](http://en.wikipedia.org/wiki/Markdown) - a good [MarkDown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) can help.
- for example, you may use MarkDown syntax to create links and section headings.
- follow the [Islandora Documentation Style Guide](docs_style_guide.md).
- have either an individual [Contributor License Agreement](https://github.com/Islandora/islandora/wiki/Contributor-License-Agreements) (CLA) on file with the Islandora Foundation, or work for an organization that has a corporate Contributor License Agreement on file with the Islandora Foundation.
- for information on how to fill out and submit a Contributor License Agreement (CLA) for yourself and/or your organization visit the [License Agreements](https://islandora.github.io/documentation/contributing/CONTRIBUTING/#license-agreements) section of the "How to contribute" documentation page.
- by participating in the Islandora Community, you are agreeing to act according to the [Islandora Code of Conduct](https://www.islandora.ca/code-of-conduct).

## How to edit documentation using a web browser

Expand All @@ -39,7 +41,7 @@ If you _are_ a member of the Islandora GitHub organization, you will be able to
![start a new branch and PR](../assets/editing-docs-branch.png)

- You will be taken to the [pull request template](https://github.com/Islandora/documentation/blob/main/.github/PULL_REQUEST_TEMPLATE.md) which will prompt you to fill out some basic information about what you have changed, and why. Replace all relevant instances of _Replace this text_ with your own text.
- You will have the option to tag _Interested Parties_, or people you would like to review your work, by writing in their GitHub account name after the `@` symbol. If you don't have anyone specific in mind, you may tag `@Islandora/8-x-committers` to alert all Islandora 8 Committers that there is a new pull request for their review.
- You will have the option to tag _Interested Parties_, or people you would like to review your work, by writing in their GitHub account name after the `@` symbol. If you don't have anyone specific in mind, you may tag `@Islandora/8-x-committers` to alert all Islandora Committers that there is a new pull request for their review.

![start a new branch and PR](../assets/editing-docs-PR.png)

Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: Islandora 8
site_name: Islandora
site_dir: site
docs_dir: docs
site_description: Documentation for Islandora 8
site_description: Documentation for Islandora

dev_addr: 'localhost:8111'
repo_url: https://github.com/Islandora/documentation
Expand Down Expand Up @@ -60,9 +60,9 @@ nav:
# also see user-intro.md#architecture for the cheeseburger/bento box analogy
# Conceptual/ reference, all user roles/ sys admins/ developers:
# procedural information should be moved out installation guides
- 'Modelling content in Islandora 8 vs. 7': 'user-documentation/objects_to_resource_nodes.md'
- 'Modelling content in Islandora vs. Legacy': 'user-documentation/objects_to_resource_nodes.md'
# conceptual, all user roles
# moved from User documentation > Content in Islandora 8
# moved from User documentation > Content in Islandora
- Islandora Defaults: 'reference/islandora_defaults_reference.md'
- Installation:
# Procedural, different user roles: clarify who the audience is for a
Expand Down Expand Up @@ -130,7 +130,7 @@ nav:
# conceptual, repository managers
- 'Versioning': 'user-documentation/versioning.md'
# conceptual/ reference, repository managers/ developers
- Content in Islandora 8:
- Content in Islandora:
# largely conceptual, repository managers and to some extent curators
# currently duplicates a section also present under "User documentation",
# develop into procedural documentation for repository
Expand Down