diff --git a/README.md b/README.md index e840c939..d9d365ba 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is a Python package template for new ARC Python packages. It automatically creates new Python packages with the recommended tooling set up and ready to go. -The recommended tooling is documented on the [UCL-ARC/python-template website](http://github-pages.arc.ucl.ac.uk/python-template/). +The recommended tooling is documented on the [UCL-ARC/python-tooling website](http://github-pages.arc.ucl.ac.uk/python-tooling/). If you're making a package within a community that has an existing package template (e.g., [`scikit-hep`](https://github.com/scikit-hep/cookie)), we recommend using their template instead of this one. @@ -18,11 +18,11 @@ If you're making a package within a community that has an existing package templ ``` 2. Run cookieninja in the desired directory ``` - cookieninja gh:ucl-arc/python-template + cookieninja gh:ucl-arc/python-tooling ``` If you have this repo locally (this may be the case if you are developing), you can alternatively run the following: ``` - cookieninja /path/to/your/checkout/of/python-template + cookieninja /path/to/your/checkout/of/python-tooling ``` 3. A series of questions will pop up to configure the project. Type the answer or hit return to use the default option (shown in square brackets). @@ -31,7 +31,7 @@ If you're making a package within a community that has an existing package templ email [temp@gmail.com]: github_username [UCL-ARC]: project_name [Python Template]: - project_slug [python-template-cookiecutter]: + project_slug [python-tooling-cookiecutter]: project_short_description [A cookieninja template with ARC recommendations.]: version [0.1.0]: Select min_python_version: @@ -48,7 +48,7 @@ If you're making a package within a community that has an existing package templ For example, for a project with the following variables: ``` - project_slug [python-template-cookiecutter]: PROJECT_SLUG + project_slug [python-tooling-cookiecutter]: PROJECT_SLUG project_name [Python Template]: PROJECT_NAME ``` @@ -88,5 +88,5 @@ If you're making a package within a community that has an existing package templ - To run cookieninja using a specific branch of the template: ``` - cookieninja https://github.com/UCL-ARC/python-template --checkout + cookieninja https://github.com/UCL-ARC/python-tooling --checkout ``` diff --git a/docs/README.md b/docs/README.md index e193a2cd..bc019544 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,23 +1,3 @@ -# python-template - -This repository documents common tooling we use in our Python projects in the [Advanced Research Computing center](https://www.ucl.ac.uk/arc/) (ARC) at [UCL](https://www.ucl.ac.uk). -It is designed as a static GitHub pages site. - -## Contributing - -The [website](https://ucl-arc.github.io/python-template/) and source pages are publicly available, but contributions are restricted to members and associate members of ARC. - -Pages all live in the `pages` sub-directory, and are written in markdown. - -To contribute: - -1. Create a new branch. -2. Modify an existing page, or create a new one. -3. Open a pull request with changes. -4. Someone who did not contribute to the PR should review it. -5. If approved, the reviewer should merge the PR. -6. If changes requested, the PR author should address the comments, then ask for review again. - ### Building locally 1. [Install jekyll](https://jekyllrb.com/docs/installation/) diff --git a/docs/_config.yml b/docs/_config.yml index 5a48fab7..4768c076 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -2,7 +2,7 @@ title: UCL ARC Python tooling description: Common Python tooling used in UCL's Advanced Research Computing center theme: just-the-docs -url: https://UCL-ARC.github.io/python-template +url: https://UCL-ARC.github.io/python-tooling aux_links: - Source repository: https://github.com/UCL-ARC/python-template + Source repository: https://github.com/UCL-ARC/python-tooling diff --git a/docs/pages/linting.md b/docs/pages/linting.md index 9e1137aa..327324e2 100644 --- a/docs/pages/linting.md +++ b/docs/pages/linting.md @@ -5,7 +5,7 @@ layout: default # Linting -See [here for example configuration](https://github.com/paddyroddy/python-template) for some of these. +See [here for example configuration](https://github.com/UCL-ARC/python-tooling/blob/main/%7B%7Bcookiecutter.project_slug%7D%7D/.pre-commit-config.yaml) for some of these. ## Code formatting diff --git a/docs/pages/templates.md b/docs/pages/templates.md index 36889e84..d83b1556 100644 --- a/docs/pages/templates.md +++ b/docs/pages/templates.md @@ -10,7 +10,7 @@ nav_order: 2 ## Recommended ARC template -The [UCL-ARC/python-template](https://github.com/UCL-ARC/python-template) repository contains our recommended package template for new ARC projects. +This [UCL-ARC/python-tooling](https://github.com/UCL-ARC/python-tooling) repository contains our recommended package template for new ARC projects. It pre-configures the recommended tools listed in the other pages of this site. If you're making a package within one of the communities listed below, we recommend using their template instead.