Skip to content

Commit 3473b62

Browse files
committed
swap link check action urlstechie/urlchecker-action for lycheeverse/lychee-action and fix broken markdown links
lychee **/*.md Issues found in 2 inputs. Find details below. [jupyterlab-extension/README.md]: ✗ [404] https://github.com/materialsproject/crystaltoolkit/workflows/Build/badge.svg | Network error: Not Found [README.md]: ✗ [404] https://github.com/richardtran415 | Network error: Not Found ✗ [404] http://www.nersc.gov/users/data-analytics/spin/ | Network error: Not Found 🔍 37 Total ✅ 34 OK 🚫 3 Errors (HTTP:3)
1 parent bfa73a7 commit 3473b62

File tree

6 files changed

+11
-15
lines changed

6 files changed

+11
-15
lines changed

.github/workflows/url-check.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,14 @@ on:
77
branches: [main]
88

99
jobs:
10-
markdown-link-check:
10+
lychee-link-check:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- name: Check out repo
1414
uses: actions/checkout@v3
1515

16-
- name: Check URL
17-
uses: urlstechie/urlchecker-action@master
16+
- name: Check for broken links
17+
uses: lycheeverse/lychee-action@v1
1818
with:
19-
file_types: .md,.py,.rst # file types to check URLs in
20-
timeout: 5 # allowed timeout for requests to resolve, default = 5 sec
21-
retry_count: 2
19+
# exclude loopback to skip localhost URLs from checking
20+
args: --exclude-loopback './**/*.md' './**/*.rst'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The [Crystal Toolkit Development Team](https://github.com/materialsproject/cryst
3232
* [Matt McDermott](https://github.com/mattmcdermott) contributed phase diagram, X-ray Diffraction, X-ray Absorption Spectrum components
3333
* [Jason Munro](https://github.com/munrojm) contributed band structure component
3434
* [Stephen Weitzner](https://github.com/sweitzner) contributed POV-Ray integration (in progress)
35-
* [Richard Tran](https://github.com/richardtran415) for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
35+
* [Richard Tran](https://github.com/CifLord) for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
3636
* [Guy Moore](https://github.com/guymoore13) for contributing magnetic moment visualization
3737

3838
New contributors are welcome, please see our [Code of Conduct.](code-of-conduct.md) If you are a new contributor please modify this README in your Pull Request to add your name to the list.
@@ -53,7 +53,7 @@ Thank you to all the authors and maintainers of the libraries Crystal Toolkit
5353
depends upon, and in particular [pymatgen](http://pymatgen.org) for crystallographic
5454
analysis and [Dash from Plotly](https://plot.ly/products/dash/) for their web app framework.
5555

56-
Thank you to the [NERSC Spin](http://www.nersc.gov/users/data-analytics/spin/) service for
56+
Thank you to the [NERSC Spin](https://www.nersc.gov/systems/spin) service for
5757
hosting the app and for their technical support.
5858

5959
Cross-browser Testing Platform and Open Source <3 generously provided by [Sauce Labs](https://saucelabs.com)

docs/_sources/introduction.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Contributors
8888
* `Matt McDermott <https://github.com/mattmcdermott>`_ contributed phase diagram, X-ray Diffraction, X-ray Absorption Spectrum components
8989
* `Jason Munro <https://github.com/munrojm>`_ contributed band structure component
9090
* `Stephen Weitzner <https://github.com/sweitzner>`_ contributed POV-Ray integration (in progress)
91-
* `Richard Tran <https://github.com/richardtran415>`_ for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
91+
* `Richard Tran <https://github.com/CifLord>`_ for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
9292
* `Guy Moore <https://github.com/guymoore13>`_ for contributing magnetic moment visualization
9393

9494

docs_rst/first_web_app.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Since callbacks do not rely on any external state, they are easy to cache.
100100
Caching is supported by many Crystal Toolkit components, but by default
101101
caching is in-memory only and not thread safe.
102102

103-
Any `Flask-Caching <https://pythonhosted.org/Flask-Caching/>`_
103+
Any `Flask-Caching <https://pythonhosted.org/Flask-Cache>`_
104104
backend is supported, we recommend ``RedisCache``:
105105

106106
::

docs_rst/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Contributors
8888
* `Matt McDermott <https://github.com/mattmcdermott>`_ contributed phase diagram, X-ray Diffraction, X-ray Absorption Spectrum components
8989
* `Jason Munro <https://github.com/munrojm>`_ contributed band structure component
9090
* `Stephen Weitzner <https://github.com/sweitzner>`_ contributed POV-Ray integration (in progress)
91-
* `Richard Tran <https://github.com/richardtran415>`_ for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
91+
* `Richard Tran <https://github.com/CifLord>`_ for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
9292
* `Guy Moore <https://github.com/guymoore13>`_ for contributing magnetic moment visualization
9393

9494

jupyterlab-extension/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# crystaltoolkit-extension
22

3-
![Github Actions Status](https://github.com/materialsproject/crystaltoolkit/workflows/Build/badge.svg)
3+
![Github Actions Status](https://github.com/materialsproject/crystaltoolkit/workflows/release/badge.svg)
44

55
A JupyterLab extension for rendering Crystal Toolkit Scene JSON files.
66

7-
8-
97
## Requirements
108

119
* JupyterLab >= 3.0
@@ -16,7 +14,6 @@ A JupyterLab extension for rendering Crystal Toolkit Scene JSON files.
1614
pip install crystaltoolkit-extension
1715
```
1816

19-
2017
## Contributing
2118

2219
### Development install

0 commit comments

Comments
 (0)