Suggestions on LDES Server Docs

[xdxxxdx]

This case is made to list all points of doc that need to improved:

• https://informatievlaanderen.github.io/VSDS-LDESServer4J/ => Increase the resolution of the Image at bottom? I feel it is too blurred.
• --
• https://informatievlaanderen.github.io/VSDS-LDESServer4J/how-to-run.html
  • Put the sample configuration first then introduce which are the optional configurations? Like this is easier to start
  • The configuration table with a better format? Thicker column lines? Now it is difficult to see there is a line in between ..

  • A empty column after default value?

• https://informatievlaanderen.github.io/VSDS-LDESServer4J/configuration/event-stream
  • To house (host?) a new Event Stream on your server, [typo]

  • SHACL (Shapes Constraint Language) (A link to SHACL ? https://www.w3.org/TR/shacl/)

• https://informatievlaanderen.github.io/VSDS-LDESServer4J/configuration/dcat -Example of a DCAT ?

[ghsnd]

Hi,

I'm reviewing the docs, and here are some more suggestions:

• https://github.com/Informatievlaanderen/VSDS-LDESServer4J/blob/bd26aa656dfd8d95bcfcc753118f79e714076012/docs/how-to-run.md?plain=1#L30: replace "This should therefor point to a publicly available url" with "This should point to a resolvable url" ? Technically it doesn't have to be public (e.g., this probably also works by modifying your hosts file when testing locally). Shouldn't the default value be e.g. 'http://localhost:8080' ?
• https://github.com/Informatievlaanderen/VSDS-LDESServer4J/blob/bd26aa656dfd8d95bcfcc753118f79e714076012/docs/how-to-run.md?plain=1#L79: version is ignored since Compose V2, so it can be omitted.
• https://github.com/Informatievlaanderen/VSDS-LDESServer4J/blob/bd26aa656dfd8d95bcfcc753118f79e714076012/docs/_configuration/event-stream.md?plain=1#L59: maybe add somewhere that {event steam} is referred to as parameter collectionName (in the swagger doc).

Probably more to come soon ;)

[jobulcke]

This effort has been done, so this issue will be closed