Skip to content

Commit 97780f4

Browse files
authored
chore: Update lychee ignore file (deephaven#6300)
I was under the impression that to do substring matching, the tool would need asterisks via regex in the file. That didn't work. I found an example of another repo using this tool and looked at their lychee ignore file to find no asterisks. This past weekend's runs failed on links that contained localhost and docs.deephaven.io. This should fix that. There is a legit broken link in the run that will be fixed as part of this PR as well.
1 parent 372f9a4 commit 97780f4

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

.lycheeignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
_localhost_
2-
_docs.deephaven.io_
1+
http://localhost:
2+
https://docs.deephaven.io/
33
https://10.0.1.50:8123/iris/connection.json
44
https://deephaven.io/core/release/vX.Y.Z/javadoc
55
https://github.com/deephaven/deephaven.io

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The Deephaven server can be installed and instantiated [from Docker](#from-docke
5555
This is the easiest way to get started with Deephaven. For complete instructions, see our [quickstart for Docker](https://deephaven.io/core/docs/getting-started/quickstart/). The table below shows installation dependencies.
5656

5757
| Dependency | Version | OS | Required/Recommended |
58-
| -------------- | -------- | --------| -------------------- |
58+
| -------------- | -------- | ------- | -------------------- |
5959
| Docker | ^20.10.8 | All | Required |
6060
| Docker compose | ^2 | All | Recommended |
6161
| Windows | 10+ | Windows | Required |
@@ -109,7 +109,7 @@ docker compose up
109109

110110
### pip-installed Deephaven
111111

112-
Users who wish to use Python but not Docker should use [pip-installed Deephaven](https://deephaven.io/core/docs/tutorials/quickstart-pip/). For users with Windows operating systems, WSL is **not** required to use Deephaven this way.
112+
Users who wish to use Python but not Docker should use [pip-installed Deephaven](https://deephaven.io/core/docs/getting-started/pip-install/). For users with Windows operating systems, WSL is **not** required to use Deephaven this way.
113113

114114
```sh
115115
pip install --upgrade pip setuptools wheel
@@ -151,7 +151,7 @@ docker run hello-world
151151
```
152152

153153
> **_NOTE:_** Internally, the Java build process will use [Gradle Auto Provisioning](https://docs.gradle.org/current/userguide/toolchains.html#sec:provisioning)
154-
to download and use the appropriate Java version for building and testing.
154+
> to download and use the appropriate Java version for building and testing.
155155
156156
> **_NOTE:_** On Windows, all commands must be run inside a WSL 2 terminal.
157157
@@ -182,13 +182,14 @@ cd deephaven-core
182182
#### Debugging
183183
184184
You can debug the server by adding the `-Pdebug` flag, and then attaching a debugger to port 5005. This can be used in conjunction with other flags. For example, if you wanted to debug a server and startup with Groovy:
185+
185186
```sh
186187
./gradlew server-jetty-app:run -Pgroovy -Pdebug
187188
```
188189
189190
## Get the authentication key
190191
191-
Deephaven, by default, uses [pre-shared key authentication](https://deephaven.io/core/docs/how-to-guides/authentication/auth-psk/) to authenticate against unauthorized access.
192+
Deephaven, by default, uses [pre-shared key authentication](https://deephaven.io/core/docs/how-to-guides/authentication/auth-psk/) to authenticate against unauthorized access.
192193
193194
### Deephaven run from Docker
194195
@@ -269,12 +270,12 @@ t = left.join(right, "DeptID", "DeptName, DeptTelephone=Telephone")
269270
270271
## Resources
271272
272-
* [Help!](https://github.com/deephaven/deephaven-core/discussions/969)
273-
* [Deephaven Community Slack](https://deephaven.io/slack)
274-
* [Discussions](https://github.com/deephaven/deephaven-core/discussions)
275-
* [Deephaven Community Core docs](https://deephaven.io/core/docs/)
276-
* [Java API docs](https://deephaven.io/core/javadoc/)
277-
* [Python API docs](https://deephaven.io/core/pydoc/)
273+
- [Help!](https://github.com/deephaven/deephaven-core/discussions/969)
274+
- [Deephaven Community Slack](https://deephaven.io/slack)
275+
- [Discussions](https://github.com/deephaven/deephaven-core/discussions)
276+
- [Deephaven Community Core docs](https://deephaven.io/core/docs/)
277+
- [Java API docs](https://deephaven.io/core/javadoc/)
278+
- [Python API docs](https://deephaven.io/core/pydoc/)
278279
279280
## Contributing
280281

0 commit comments

Comments
 (0)