Contributing

Help us enhance and fix MFractor docs so everyone can get the most of this tool.

Introduction

The MFractor Documentation site is an open source project created and maintained by MFractor. Our goal is to provide rich documentation and reference to our users and customers so they can get the most of the tool. The docs is not only about the tool features itself, but we always try to bring knowledge on development platforms that MFractor assists.

Mission

Our readers must learn something new beyond the product feature they're searching information itself and enrich their knowledge of the platforms that our tool assists.

Documenting a product is critical and hard to do right and keep up to date. The MFractor team is very small and strive to keep up with the ever changing product features. Community contribution is very desired and welcome to achieve the goal of having this site not only as a source of information for MFractor but also as an important knowledge base for developers.

Contribution Workflow

Contributing to MFractor Documentation is much like any Git hosted open source project:

  1. Pick an issue you wish to contribute and comment on
  2. Fork the project repository at GitHub
  3. Make your changes to your forked repository
  4. Open a Pull Request to merge your changes to the main repo
    • If your changes are accepted we'll merge it and notify you about it.
    • We may ask you for additional changes or reply with suggestions through comments on the Pull Request.

In case we add suggestions to your Pull Request we will provide a 3 day time-frame for you to review before merging your changes. We may decide to apply the suggestions internally after the merge.

This is the high level diagram of the Contribution Workflow:

Important

All the work to this repository is tracked through issues. We can't track forks to know about ongoing contributions to the project, so please keep your comments on the issues you may be working on so we can manage conflicts. If you've found a problem or a missing documentation that is not listed on the issues, please open one before starting your work.

Info

We may change parts of your contribution to fix typos, correct data or add missing information. This will be done without notice.

Accepted contributions will be acknowledge on a specific section of the home page. Don't add the acknowledgements to your Pull Requests, otherwise they will be rejected. Citations will be only handled internally by our moderation team.

Requirements

This documentation is written using MkDocs, a popular platform for software documentation sites.

To contribute you will need to install a few things:

  • Install Python.
  • Install pip.
  • Install mkdocs from the pip tool pip install mkdocs.
  • Install the [Material Theme for mkdocs] from pip install mkdocs-material

Important

Make sure to install mkdocs and the material theme both using pip. If you install mkdocs from Homebrew and them install the material theme from pip (the only place where its available as a package) you will get errors trying to compile the docs or running it locally.

Extensions

admonition and codehilite are part of the material theme.

markdown_extensions:
  - attr_list
  - admonition
  - codehilite

Troubleshooting

If the Material Theme isn't installed when you try to run the project it won't work and you'll get the following error:

mkdocs serve
INFO    -  Building documentation... 
ERROR   -  Config value: 'theme'. Error: Unrecognised theme name: 'material'. The available installed themes are: readthedocs, mkdocs 

Make sure to install mkdocs and material theme from pip.

Get in touch

If you need further assistance on contribution please refer to Matthew Robins or Rafael Veronezi or open an issue. We'll be glas to assist.

Comments