openlayers / openlayers/openlayers
Dead links in the apidocs
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 12.6k
- Forks
- 3.2k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 21
Description
Describe the bug
There are multiple dead links in the api docs. See also #10213
To Reproduce
Steps to reproduce the behavior:
- Run the following script after configuring the
srcandwwwvariables.
It recursively checks for dead links in the api docs
#!/bin/bash
dir=build/apidoc
src=~/openlayers/$dir
www=http://localhost:8080/$dir
for link in $(\
wget --spider --no-directories --no-verbose --recursive --no-parent $www \
|& grep --before-context=1 -- "-- broken link!!!" \
| grep --only-matching --perl-regexp "(?<=/${dir}/).*\.html" \
| sort \
); do
printf "\n${link#:} 404, linked from:\n"
grep --recursive --files-with-matches "${link}" "${src}" \
| grep --only-matching --perl-regexp "(?<=${src}/).*" \
| sort \
| sed 's/^/ /'
done
- current output 0519e908d55fbeb95408a06644930adfe2256cda:
module-ol_Image-ImageWrapper.html 404, linked from:
module-ol_Image.html
module-ol_source_Image.ImageSourceEvent.html
module-ol_ObjectEventType.html 404, linked from:
module-ol_Geolocation.html
module-ol_Map.html
module-ol_Overlay.html
module-ol_View.html
module-ol_layer_Base.html
module-ol_TileCache-TileCache.html 404, linked from:
module-ol_source_OGCVectorTile-OGCVectorTile.html
module-ol_source_VectorTile-VectorTile.html
module-ol_centerconstraint.html 404, linked from:
module-ol_View.html
module-ol_expr_expression.html 404, linked from:
module-ol_style_flat.html
module-ol_resolution.html 404, linked from:
module-ol_Image.html
module-ol_resolutionconstraint.html 404, linked from:
module-ol_View.html
module-ol_rotationconstraint.html 404, linked from:
module-ol_View.html
module-ol_style_literal.html 404, linked from:
module-ol_style_expressions.html
Expected behavior
There should be no dead links in the api docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Run the supplied link-checking script against build/apidoc after configuring src and www, then inspect the listed missing pages and their linking API documentation entries. Trace how these pages and references are generated, and verify completion by rerunning the script with no dead links reported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash, javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100