Skip to content

Commit

Permalink
Merge pull request #250 from geoblacklight/docs_updates
Browse files Browse the repository at this point in the history
Docs updates
  • Loading branch information
karenmajewicz authored Feb 9, 2024
2 parents e78117f + eb1064f commit 0d1053a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 23 deletions.
27 changes: 4 additions & 23 deletions docs/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,30 +87,11 @@ GeoBlacklight follows the practice of [Semantic Versioning](https://semver.org/)
- the GeoBlacklight JavaScript interface
- the GeoBlacklight view interface

### Contributing code or documentation
GeoBlacklight welcomes code and documentation contributions from anyone. We follow the [pull request](https://help.github.com/articles/using-pull-requests/) model for contributing on GitHub. GeoBlacklight uses a suite of tests to express its features and protect from bugs.

When proposing major new features that may introduce a breaking change, please make sure to communicate with the community so the full implications can be evaluated. Others may be able to help make these changes backwards-compatible with existing versions.

#### Pull request overview
1. Fork it ( http://github.com/my-github-username/geoblacklight/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

#### Merging Changes

- Committers are discouraged from merging their own pull requests.
- Please take the time to review the changes and get a sense of what is being changed. Things to consider:
- Does the commit message explain what is going on?
- Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
- Do all new methods, modules, and classes have comments? Do changed methods, modules, and classes have comments?
- Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
- Did the Travis tests complete successfully?
- If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
- If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
### Contributing Code or Documentation

If you would like to contribute to the code base, see [For Developers](./docs/developers.md) for information about setting up a development environment, and read our [contributing guidelines](https://github.com/geoblacklight/geoblacklight/blob/main/CONTRIBUTING.md).

To contribute to this documentation, go to [this website's repository on GitHub](https://github.com/geoblacklight/geoblacklight.github.io).

## How to Connect

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Welcome to the GeoBlacklight Documentation

The GeoBlacklight documentation aims to help anyone interested in implementing the software, or developers working to customize or upgrade an existing implementation.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ nav:
- Blog:
- blog/index.md
- Documentation:
- 'docs/index.md'
- Install:
- 'Quick Start': 'docs/geoblacklight_quick_start.md'
- 'For Developers': 'docs/developers.md'
Expand Down

0 comments on commit 0d1053a

Please sign in to comment.