-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
180 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Create a GitHub Issue | ||
|
||
## Overview | ||
The Islandora community uses GitHub issues to track bug reports, requests for improvements, requests for new features, and use cases. Issues are welcome from anyone who works with Islandora. | ||
|
||
The Islandora [issue queue](https://github.com/Islandora/documentation/issues) is maintained in the Islandora [Documentation](https://github.com/Islandora/documentation) repository on GitHub. Issues posted to the queue are reviewed weekly on the Islandora [Tech Call](https://github.com/Islandora/islandora-community/wiki/Tech-Call-Meetings-2022). Members of the Islandora community can then respond to posted issues by replying with comments, taking on the assignment to do the work described in the issue, or making pull requests relating to the issue. | ||
|
||
!!! Tip "Video version available" | ||
The material in this tutorial is presented in our video, [Create a GitHub Issue](https://youtu.be/eHBIYlRxEtk). | ||
|
||
## Before you start | ||
|
||
- You will need to have an account on [GitHub](https://github.com/join). These are free to register and require only a name and email address. | ||
|
||
|
||
## How to create an issue in the Islandora issue queue | ||
|
||
1. Go to [https://github.com/Islandora/documentation/issues](https://github.com/Islandora/documentation/issues) | ||
2. Click on **New issue**: | ||
![New Issue button](../assets/create_issues_newissue.jpg) | ||
3. Select the type of issue you are creating, as this will provide you with a template to describe your issue. | ||
![Bug report, Documentation, Feature Request, and Use case are presented as possible issue templates when opening a new issue.](../assets/create_issues_Issue_Templates.png) | ||
4. Fill in the information for your issue: | ||
1. Give your issue a descriptive title following the text that is already provided in the template title, ex. _[BUG]._ | ||
2. Fill in the body of your issue under the **Write** tab. A template of questions will be provided based on the type of issue selected. Depending on your issue, you may need to: describe a bug you are seeing and how to reproduce it, describe how an existing feature could be improved, describe a new feature and how it should work, or describe documentation that needs to be written or expanded. | ||
3. Use the built-in text editor to help format your issue in [Markdown](http://en.wikipedia.org/wiki/Markdown). | ||
4. Use the **Preview** button to see how your issue will be published and ensure the formatting looks the way you want. | ||
5. Click **Submit new issue** to add your issue to the queue. | ||
6. Optionally, Add labels to your issue to assign it to available categories, such as "documentation" or "question." Click on as may labels as you like. When you click outside of the drop-down list, the selected labels will be applied to your issue. | ||
|
||
![Gif walkthrough of templates](../assets/create_issues_Describing_Issue.gif) <img src="https://raw.githubusercontent.com/Islandora/documentation/3635b2d77681ce7da2fdbfd8f951921e97cc6acb/docs/assets/create_issues_Add_Labels.png" alt="Labels on the right sidebar of Github issue creation" width= 250 /></p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Documentation Style Guide | ||
|
||
## Do's | ||
|
||
- Use a GitHub Pull Request to submit documentation. | ||
- See the [Editing Documentation](https://islandora.github.io/documentation/contributing/editing-docs/) documentation page for information on creating a Pull Request. | ||
- Make it clear if the documentation is based on a particular configuration (such as the Install Profile Demo) or if it applies to any deployment of Islandora. | ||
- Submit documentation formatted in [Markdown](https://en.wikipedia.org/wiki/Markdown) format. | ||
- Include a top-level heading for the whole page (using `#`) | ||
- Please add Markdown headings (`#` and `##`) to the content sections. | ||
|
||
- Use the "bold/emphasis" style in Markdown by enclosing text in double asterisks or underscores, `**bold text**` or `__bold text__`, for UI elements that users will interact with. For example, a button label for a button that must be pressed should be made bold in Markdown. | ||
- Use the "italics" style in Markdown by enclosing text in single asterisks or underscores, `*italic text*` or `_italic text_`, for UI elements that have a label or title if you need to reference them in the documentation. For example, a title of a screen or page that will visit should be made italic in Markdown. | ||
- Use `>>` and `**bold text**` to indicate clicking through nested menu items, and also include the direct path. _Example:_ | ||
``` | ||
**Administration** >> **Structure** >> **Views** (/admin/structure/views) | ||
``` | ||
- Use `-` instead of `*` for bulleted lists. Indent four (4) spaces for nested lists (Github renders nesting in markdown with 2 spaces, but mkdocs needs 4). | ||
_Example:_ | ||
``` | ||
- I am a list item | ||
- And I am a sub-item. | ||
``` | ||
- Upload images to the 'assets' folder and reference them from there. | ||
- For file naming, use underscores between words and prefix all file names with the page name, e.g. context_display_hints.jpg for the image showing how to set display hints in the context menu. | ||
- Use the [Admonition syntax](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) to create notes like this (four-space indent required): | ||
|
||
_Example:_ | ||
|
||
``` | ||
!!! note "Helpful Tip" | ||
I am a helpful tip! | ||
``` | ||
|
||
_Result:_ | ||
|
||
!!! note "Helpful Tip" | ||
I am a helpful tip! | ||
|
||
- Use our custom `islandora` type within the Admonition syntax to call attention to areas where Islandora configuration differs from standard Drupal configuration: | ||
|
||
_Example:_ | ||
|
||
``` | ||
!!! islandora "Lobster trap" | ||
This setting is specific to Islandora and is not standard to Drupal. | ||
``` | ||
|
||
_Result:_ | ||
|
||
!!! islandora "Lobster trap" | ||
This setting is specific to Islandora and is not standard to Drupal. | ||
|
||
## Don'ts | ||
|
||
- Do not leave any "trailing spaces" at the end of lines of content. | ||
- Do not use "curly" quotes and apostrophes, use only "straight" quotes and apostrophes. | ||
- Do not upload images that are excessively large in file size (remember, these docs are part of the software!) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
``` | ||
# ![Alt text](Mascot Image) Repository Name | ||
[![Minimum PHP Version](link)](link) | ||
[![Build Status](link)](link) | ||
[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md) | ||
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](./LICENSE) | ||
[![codecov](link)](link) | ||
## Introduction | ||
A brief introduction and summary of the module. | ||
## Requirements | ||
This module requires the following modules/libraries: | ||
* [Name](Link) | ||
* [Name](Link) | ||
* Any | ||
* Requirements | ||
## Installation | ||
Installations instructions. | ||
## Configuration | ||
Describe path to configuration. | ||
Include a screenshot of configuration page. When using your choice of screenshot software, resize your browser | ||
first to avoid wide screenshots. Here are a few browser extension examples to take screenshots. | ||
- [Fireshots](https://chrome.google.com/webstore/detail/take-webpage-screenshots/mcbpblocgmgfnpjjppndjkmgjaogfceg) | ||
- [Nimbus](https://chrome.google.com/webstore/detail/nimbus-screenshot-screen/bpconcjcammlapcogcnnelfmaeghhagj) | ||
To upload the image drag the image into the comment section of an existing Pull Request. | ||
This will generate the image URL link for you | ||
![Configuration Screenshot](https://user-images.githubusercontent.com/2857697/39014759-e2ef9c1e-43e0-11e8-921c-c2a3234d65d2.jpg) | ||
Video example on [How to attach an Image in README.md file with Github](https://youtu.be/wVHJtL-y7P0) | ||
## Other Sections As Needed | ||
Sections specific to this repo, but not found in all repos, should go here. | ||
## Documentation | ||
Further documentation for this module is available on the [Islandora documentation site](https://islandora.github.io/documentation/). | ||
## Troubleshooting/Issues | ||
Having problems or solved a problem? Check out the Islandora google groups for a solution. | ||
- [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora) | ||
- [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev) | ||
## FAQ | ||
Q. Is this normal? | ||
A. Yes. This is normal. Why ... | ||
## Maintainers/Sponsors | ||
Current maintainers: | ||
- [Maintainer Name](https://github.com/maintainer_github) | ||
- [Another Maintainer](https://github.com/maintainer_github) | ||
This project has been sponsored by: | ||
- Some really awesome sponsor | ||
## Development | ||
If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora/documentation/wiki). We love to hear from you! | ||
If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](https://drive.google.com/file/d/1k6eCM5EV-w4I4ErkiGj4NJwvLnXkejyk/view?usp=sharing) or [Corporate Contributor License Agreement](https://drive.google.com/file/d/1-SQYuHWRxvltQYgkFWpYv7nGbvJp1u8h/view?usp=sharing). Please see the [Contributors](https://github.com/Islandora/islandora-community/wiki/Onboarding-Checklist) pages on Islandora.ca for more information. | ||
We recommend using the [islandora-playbook](https://github.com/Islandora-Devops/islandora-playbook) to get started. If you want to pull down the submodules for development, don't forget to run git submodule update --init --recursive after cloning. | ||
Also include any Travis gotcha's here. | ||
## License | ||
[Name](link). GPLv2 for Drupal modules. MIT for other modules. | ||
``` |