Skip to content

Commit 6e13141

Browse files
committed
Documentation refactor -- should be able to use gh-deploy now.
1 parent f4431d3 commit 6e13141

File tree

15 files changed

+584
-5
lines changed

15 files changed

+584
-5
lines changed

docs/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

docs/camel/sync/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../camel/sync/README.md

docs/contributing/coding-standards.md

+510
Large diffs are not rendered by default.
File renamed without changes.

docs/contributing/git-guidelines.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
In general we follow the [[Git guidelines|https://wiki.duraspace.org/display/FCREPO/Git+Guidelines+and+Best+Practices#GitGuidelinesandBestPractices-CommitMessages]] for the fcrepo project since they are sensible. They go into a lot of detail about line endings which we don't need to worry about as much at the moment. Specifically we should try and do the following, however:
2+
3+
# Commit Messages
4+
5+
Commit messages should follow the guidelines described in detail at [here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
6+
7+
In summary:
8+
9+
* First line: Github issue number in all caps (if applicable), followed by a brief description (~ 50 characters)
10+
* Second line: blank
11+
* Following lines: more detailed description, line-wrapped at 72 characters. May contain multiple paragraphs, separated by blank lines. Link to the Github issue, if applicable.
12+
Use the present tense when writing messages, i.e. "Fix bug, apply patch", not "Fixed bug, applied patch."
13+
14+
Using the git command line tool you can add multi-line commit messages by typing a \ at the end of a line and continuing to type. E.g.,
15+
```console
16+
$ git commit -m "ISLANDORA-110 Cannot delete content model when there is only one left.\
17+
\
18+
Remove logic that prevents delete widget from being drawn."
19+
$
20+
```
21+
# Tags
22+
23+
Each major release of Islandora has a tag associated with it. This tag will point to a commit in a given release branch. This is the code actually released in the zip files on a given release's release notes page. This allows us to have an easily accessible archive of past releases.
24+
25+
# Branches
26+
27+
## Main Project Branches
28+
29+
Many of our projects are dependent on Drupal, and we have projects with multiple `master` branches, one for each supported version of Drupal, the main branches for each projects repository are named after the version of Drupal that is supported by that version of the project. For example Islandora has `6.x` for Drupal 6 and `7.x` for Drupal 7. These branches should be treated as the `master` branch for each version, and not developed on top of as is mentioned above. All of our projects should follow this naming convention for their `master` branch for consistency.
30+
31+
There are also release branches associated with each of the master branches. These were named after the master branch they correspond to. For example: `6.x-release` and `7.x-release`. These branches were an archive of the "blessed" released code. They exist mainly so that we could do things like modify the module.info files for releases and cherry-pick commits from the master branch to backport bugfixes into a release. With Islandora 7.x-1.3 we have moved to a new approach where we will have a new branch for each release. When simple pull requests will not work for bringing code into these branches we will not require cherry-pick`d commits; simply re-commited edits will be acceptable. It is however highly advisable to use cherry-pick for anything other than the most trivial pull requests.
32+
33+
## Issue / Topic Branches
34+
35+
All Github issues should be worked on in separate git branches. The branch name should be the same as the Github issue number, including all-caps, so ISLANDORA-153, ISLANDORA-118, etc.
36+
37+
Example: `git checkout -b 7.x-2.x-ISLANDORA-977` or `git checkout -b 7.x-2.1-ISLANDORA-977`
38+
39+
When working on a branch, before committing and merging it's best to pull updates from the 7.x branch or current release branch (ex. 7.x-1.4) into your own branch. This makes for more graceful merge logic and more intuitive-looking github graphs. This is discussed extensively in the [[Development in a local branch|https://wiki.duraspace.org/display/FCREPO/Git+Guidelines+and+Best+Practices#GitGuidelinesandBestPractices-Developmentinalocalbranch]] section of the fcrepo git guidelines.
40+
41+
When ready to have a branch merged into 7.x and/or release branch, the Github ticket should be resolved with a status of 'Ready to test'. We will discuss the changes at the weekly committers call and then if agreed upon the release manager will merge the changes into master and delete the topic branch. Once the merge with 7.x and/or release branch is complete, change the fix status of the Github ticket to 'Ready for release'.
42+
43+
## Pull requests
44+
45+
When creating a pull request, if the pull request is not trivial, please make sure to provide an appropriate amount of information with the pull request. Once the request is made, Travis-CI will be initiated. Travis-CI will run PHP Codesniffer, Drupal Coding Standards, PHP Copy/Paste Detector, and any module specific tests. When those tests pass, a community reviewer will review the pull request. If a week goes by without a maintainer noticing a pull request, please mention @manez or @ruebot in a comment on the pull request and they will shepherd the process.
46+
47+
Community members who have push/merge permissions on a repository should **never** push directly to a repo, nor merge their own pull requests.

docs/drupal/islandora/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../drupal/islandora/README.md
File renamed without changes.

docs/install/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../install/README.md

docs/sources/README.md

-1
This file was deleted.

docs/sources/camel/sync/README.md

-1
This file was deleted.

docs/sources/drupal/islandora/README.md

-1
This file was deleted.

docs/sources/install/README.md

-1
This file was deleted.
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Introduction
2+
3+
This documentation is build using [mkdocs](http://www.mkdocs.org/), a static site generator that is geared towards building project documentation. The documentation created in the [Markdown](http://en.wikipedia.org/wiki/Markdown) format, and it all resides in the `[docs](https://github.com/Islandora-Labs/islandora/tree/7.x-2.x/docs)` directory in the repository. The organization of the documenation is controlled by the `mkdocs.yml` in the root of the repository.
4+
5+
## Build and Deploy documentation
6+
7+
Documentation is build by running to the following command in the root of the repository:
8+
9+
`mkdocs build --clean`
10+
11+
This command will create a static `site` folder in the root of the repository.
12+
13+
You can preview any changes you have made to the documentation by running the following command:
14+
15+
`mkdocs serve`
16+
17+
And then visiting http://localhost:8111 in your browser.
18+
19+
To deploy documenation to GitHub Pages, issue the following command:
20+
21+
`mkdocs gh-deploy --clean`

docs/mkdocs.yml mkdocs.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: Islandora
22
site_dir: site
3-
docs_dir: sources
3+
docs_dir: docs
44
site_description: Documentation for Islandora
55

66
dev_addr: 'localhost:8111'
@@ -27,3 +27,4 @@ pages:
2727

2828
# Technical Documentation
2929
- ['technical-documentation/technical_design.md', 'Technical Documentation', 'Technical Design']
30+
- ['technical-documentation/docs-build.md', 'Technical Documentation', 'How to build documenation']

0 commit comments

Comments
 (0)