Merge pull request #46 from TUDelftGeodesy/update_docs

Update docs
TUDelftGeodesy · Jan 15, 2024 · 7f3c8c5 · 7f3c8c5
2 parents f7651e1 + 03552f7
commit 7f3c8c5
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 23 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -26,7 +26,7 @@ identifiers:
   - type: doi
     value: 10.5281/zenodo.7717112
     description: Zenodo
-repository-code: 'https://github.com/MotionbyLearning/sarxarray'
+repository-code: 'https://github.com/TUDelftGeodesy/sarxarray'
 keywords:
   - earth-observation
   - sar

diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # SarXarray
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7717027.svg)](https://doi.org/10.5281/zenodo.7717027)
-[![License](https://img.shields.io/github/license/MotionbyLearning/sarxarray)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/github/license/TUDelftGeodesy/sarxarray)](https://opensource.org/licenses/Apache-2.0)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7980/badge)](https://www.bestpractices.dev/projects/7980)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=MotionbyLearning_sarxarray&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=MotionbyLearning_sarxarray)
-[![Build](https://github.com/MotionbyLearning/sarxarray/actions/workflows/build.yml/badge.svg)](https://github.com/MotionbyLearning/sarxarray/actions/workflows/build.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=TUDelftGeodesy_sarxarray&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=TUDelftGeodesy_sarxarray)
+[![Build](https://github.com/TUDelftGeodesy/sarxarray/actions/workflows/build.yml/badge.svg)](https://github.com/TUDelftGeodesy/sarxarray/actions/workflows/build.yml)
 
 SARXarray is an open-source Xarray extension for Synthetic Aperture Radar (SAR) data. It is especially designed to work with large volume complex data, e.g. Single Look Complex (SLC) data, as well as derived products such as interferogram stacks. 
 
@@ -20,7 +20,7 @@ pip install sarxarray
 or from the source:
 
 ```sh
-git clone [email protected]:MotionbyLearning/sarxarray.git
+git clone [email protected]:TUDelftGeodesy/sarxarray.git
 cd sarxarray
 pip install .
 ```
@@ -29,4 +29,4 @@ Note that Python version `>=3.10` is required for SARXarray.
 
 ## Documentation
 
-For more information on usage and examples of SARXarray, please refer to the [documentation](https://motionbylearning.github.io/sarxarray/).
+For more information on usage and examples of SARXarray, please refer to the [documentation](https://tudelftgeodesy.github.io/sarxarray/).
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 # SARXarray Contributing Guidelines
 
 
-We welcome any kind of contribution to our software, from simple comment 
+We welcome any kind of contribution to our software, from a simple comment 
 or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). 
 Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
 
@@ -16,30 +16,30 @@ The sections below outline the steps in each case.
 
 ## You have a question
 
--  use the search functionality [here](https://github.com/MotionbyLearning/sarxarray/issues)
+-  use the search functionality in [GitHub issue](https://github.com/TUDelftGeodesy/sarxarray/issues)
 to see if someone already filed the same issue;
--  if your issue search did not yield any relevant results, make a new issue;
--  apply the "question" label; apply other labels when relevant.
+-  if your issue search did not yield any relevant results, create a new issue;
+-  add the "question" label; include other labels when relevant.
 
 ## You think you may have found a bug
 
-- use the search functionality [here](https://github.com/MotionbyLearning/sarxarray/issues) to see if someone already filed the same issue;
-- if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
+- use the search functionality in [GitHub issue](https://github.com/TUDelftGeodesy/sarxarray/issues) to see if someone already filed the same issue;
+- if your issue search did not yield any relevant results, create a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
     - the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas>) of the commit that is causing your problem;
     - some identifying information (name and version number) for dependencies you're using;
     - information about the operating system;
-- apply relevant labels to the newly created issue.
+- add relevant labels to the newly created issue.
 
 ## You want to make some kind of change to the code base
 
 - (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
 - (**important**) wait until some kind of consensus is reached about your idea being a good idea;
-- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
-- make sure the existing tests still work. First, install the development dependencies as `pip install .[dev]`, and then run `pytest tests`;
+- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions from GitHub: [instruction 1: configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [instruction 2: syncing a fork](https://help.github.com/articles/syncing-a-fork/));
+- make sure the existing tests still work by running, e.g. `pytest tests`;
 - add your own tests (if necessary);
-- update or expand the documentation. Make sure the documentation is built successfully: first, install documentation dependencies as `pip install .[docs]` and then run `mkdocs build`.
+- update or expand the documentation;
 - make sure the linting tests pass by running `ruff` in the project root directory: `ruff check .`;
-- [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the SARXarray repository on GitHub;
-- create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
+- [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the sarxarray repository on GitHub;
+- create the pull request, e.g. following [the instructions: creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
 In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
diff --git a/examples/demo_sarxarray.ipynb b/examples/demo_sarxarray.ipynb
@@ -31,7 +31,7 @@
     "To execute this notebook, fiest clone the `sarxarray` repostory to your local:\n",
     "\n",
     "```sh\n",
-    "git clone [email protected]:MotionbyLearning/sarxarray.git\n",
+    "git clone [email protected]:TUDelftGeodesy/sarxarray.git\n",
     "```\n",
     "\n",
     "Then get into the repository directory:\n",

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: SARXarray Documentation
-repo_url: https://github.com/motionbylearning/sarxarray/
+repo_url: https://github.com/TUDelftGeodesy/sarxarray/
 repo_name: SARXarray
 
 nav:

diff --git a/pyproject.toml b/pyproject.toml
@@ -35,10 +35,10 @@ classifiers=[
 ]
 
 [project.urls]
-repository = "https://github.com/MotionbyLearning/sarxarray"
+repository = "https://github.com/TUDelftGeodesy/sarxarray"
 doi = "https://doi.org/10.5281/zenodo.7717112"
-documentation = "https://motionbylearning.github.io/sarxarray/"
-changelog = "https://motionbylearning.github.io/sarxarray/CHANGELOG/"
+documentation = "https://tudelftgeodesy.github.io/sarxarray/"
+changelog = "https://tudelftgeodesy.github.io/sarxarray/CHANGELOG/"
 
 [project.optional-dependencies]
 dev = [