diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d2cac3..7e23d55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents ## I Have a Question -> If you want to ask a question, we assume that you have read the available [Documentation](https://amoccommunity.github.io/amocatlas/). +> If you want to ask a question, we assume that you have read the available [Documentation](https://amoccommunity.github.io/AMOCatlas/). Before you ask a question, it is best to search for existing [Issues](https://github.com/AMOCcommunity/amocatlas/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. @@ -62,7 +62,7 @@ Depending on how large the project is, you may want to outsource the questioning A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. - Make sure that you are using the latest version. -- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://amoccommunity.github.io/amocatlas/). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://amoccommunity.github.io/AMOCatlas/). If you are looking for support, you might want to check [this section](#i-have-a-question)). - Collect information about the bug: - Stack trace (Traceback) or screenshot error message - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) @@ -99,7 +99,7 @@ This section guides you through submitting an enhancement suggestion for amocatl #### Before Submitting an Enhancement - Make sure that you are using the latest version. -- Read the [documentation](https://amoccommunity.github.io/amocatlas/) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Read the [documentation](https://amoccommunity.github.io/AMOCatlas/) carefully and find out if the functionality is already covered, maybe by an individual configuration. - Perform a [search](https://github.com/AMOCcommunity/amocatlas/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. @@ -151,7 +151,7 @@ All other notebooks (`demo.ipynb`, etc.) should have their outputs cleared befor ### Improving The Documentation -Our [documentation](https://amoccommunity.github.io/amocatlas/) is built from the function docstrings and the [example notebook](https://amoccommunity.github.io/amocatlas/demo-output.html). If you think the documentation could be better, do not hesitate to suggest an improvement! Either in an Issue or a PR. +Our [documentation](https://amoccommunity.github.io/AMOCatlas/) is built from the function docstrings and the [example notebook](https://amoccommunity.github.io/AMOCatlas/demo-output.html). If you think the documentation could be better, do not hesitate to suggest an improvement! Either in an Issue or a PR. To build the documentation locally you need to install a few extra requirements: diff --git a/README.md b/README.md index beab850..74ad58d 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ datasets = readers.load_dataset("rapid") # Returns raw data as before ## Documentation -Documentation is available at [https://amoccommunity.github.io/amocatlas](https://amoccommunity.github.io/amocatlas/). +Documentation is available at [https://amoccommunity.github.io/AMOCatlas](https://amoccommunity.github.io/AMOCatlas/). Check out the demo notebook `notebooks/demo.ipynb` for example functionality. @@ -272,7 +272,7 @@ The observing arrays and datasets accessed through AMOCatlas are supported by: - **FW2015 data**: Based on Frajka-Williams, E. (2015), "Estimating the Atlantic overturning at 26°N using satellite altimetry and cable measurements" -Dataset access and processing via [AMOCatlas](https://github.com/AMOCcommunity/amocatlas). +Dataset access and processing via [AMOCatlas](https://github.com/AMOCcommunity/AMOCatlas). ## Contributing @@ -300,4 +300,4 @@ Example figures generated by the notebook: --- -*For questions or support, please open an [issue](https://github.com/AMOCcommunity/amocatlas/issues) or check our [documentation](https://amoccommunity.github.io/amocatlas/).* \ No newline at end of file +*For questions or support, please open an [issue](https://github.com/AMOCcommunity/amocatlas/issues) or check our [documentation](https://amoccommunity.github.io/AMOCatlas/).* \ No newline at end of file