-
Notifications
You must be signed in to change notification settings - Fork 662
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
mkdocs serve
links clean up
#1326
Comments
So I think the docs need some love. I wonder when I change these links (just some examples)
to
Then the links will work locally in my editor and on my local mkdocs server. But will these kind of changes break the website? When I change/fix all links this would affect like 25 files. |
I was looking at the official guide on links here: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages On quick review I was not able to find much on links in the Material docs https://squidfunk.github.io/mkdocs-material/setup/ But you can setup the website locally and build and serve it to test the links. There is the guide on the website here: https://sedona.apache.org/latest/setup/compile/#compile-the-documentation |
Ok, I think I got it. I issued the following pull request: #1334. Output is now as follows:
|
To explain a bit futher. A lot of these constructs were like:
I replaced them with
so the relative paths are now correct, alt and title properties being applied and size is set correctly. Following occurrences:
I replaced them with
adding the .md suffix and removing the leading forward slash which I think is not necessary. Also the slash just before the # anchor can be removed. I hope this works out beautifully for all editors/ide's I currently use Jetbrains IDE. |
We have an issue with the changes mentioned here: |
I issued a pull request, could you have a look? #1359 |
Expected behavior
Links should be cleaned up and most of the
INFO
messages about links should be removed.And the links should also work on the GitHub website when viewing the Markdown docs.
Actual behavior
When running locally:
mkdocs serve
we have a lot of extra
INFO
messages that mention our links can be cleaned up.If you browse the docs directly on GitHub some of these links are broken.
You can run
mkdocs serve 2> mkdocs-serve-output.txt
to pipe the error messages to a file.Example output below
Steps to reproduce the problem
Run:
mkdocs serve
and watch the output in the consoleSettings
Sedona version = master
Apache Spark version = ?
Apache Flink version = ?
API type = Scala, Java, Python?
Scala version = 2.11, 2.12, 2.13?
JRE version = 1.8, 1.11?
Python version = Python 3.11.6
Environment = Standalone, AWS EC2, EMR, Azure, Databricks?
The text was updated successfully, but these errors were encountered: