Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 3.55 KB

contributing.md

File metadata and controls

51 lines (39 loc) · 3.55 KB
Raw

Welcome

Welcome to the Ocean Mapping Community Wiki!

Thank you for contributing your expertise and experience.

As with the rest of the wiki, these Contribution Guidelines are in development to help establish a high degree of relevance and ease-of-use.

In all cases, we seek to follow the Code of Conduct and GitHub Community Guidelines

Scope

It is important to consider the scope of the wiki so its content is relevant and easily maintained. Suggested topics for multibeam and other systems have been added by the first contributors, highlighting some areas of common interest.

The intent is to point users, new and expert, toward the most helpful and up-to-date resources so they can make informed decisions about installation, operation, and processing. It is not meant to be prescriptive for any particular system or insist on any 'one size fits all' approach.

Content should:

  1. Apply broadly for mapping operations
  2. Highlight examples of successful use cases
    1. Show us how you did it!
  3. Discuss limitations or caveats of an approach
  4. Protect IT security and sensitive information
  5. Respect the expertise of others and differences among programs

Troubleshooting steps are also of interest for solving common issues.

Adding and editing content

Through GitHub

Please contact us to be added as a GitHub collaborator.

  1. Review the existing topics to see where your content fits.
  2. Whenever possible, expand on existing topics and add sub-topics to existing pages.
    1. As the site grows, we will reorganize as necessary to improve clarity or context.
  3. Add or edit content directly with the GitHub wiki editing features
    1. Check out GitHub's quick guides for adding or editing wiki pages and basic syntax to get started
  4. Images require URLs; upload images from your computer to the wiki repository (Code --> Add file) to generate a URL
  5. Wherever possible, link to resources (e.g., SOPs) hosted by others rather than uploading separate copies to the repository
    1. This will simplify updates as new versions of these documents are released

Remember this is new for many of us and we are excited for your contributions!

Contact us

You don't have join GitHub to contribute. Please reach out to any of the wiki managers with the content or updates you'd like to see.

Support

Helpful resources from GitHub and others:

  1. Writing on GitHub
  2. Using wikis
  3. Markdown cheatsheet
  4. Using GitHub Issues for troubleshooting
  5. Resizing images in articles
  6. Add other resources you like!