aklivity / zilla-docs

0 stars 11 forks source link

Docs new structure and deployment #12

Closed vordimous closed 1 year ago

vordimous commented 1 year ago

This is the remaining changes to get the docs to a point where new items can be added and further polishing can be done to the existing resources. Here is the live site: https://aklivity-docs.pages.dev/zilla/next after feedback: https://vordimous.github.io/zilla-docs/next/

jfallows commented 1 year ago

Please remove Contributors from footer and leave the last updated timestamp.

jfallows commented 1 year ago

Please enhance the link checking to ensure no .md links are left in the rendered HTML.

vordimous commented 1 year ago

Please enhance the link checking to ensure no .md links are left in the rendered HTML.

It looks like the double back tics and potentially the issue with these links are from the gitbook exported md: https://github.com/aklivity/zilla-docs/blob/develop/reference/zilla.yaml/binding-http-kafka.md

@jfallows Do you want to address all of this on this PR or make a separate one to do more review and try to find any more of these types of issues?

jfallows commented 1 year ago

Please enhance the link checking to ensure no .md links are left in the rendered HTML.

It looks like the double back tics and potentially the issue with these links are from the gitbook exported md: https://github.com/aklivity/zilla-docs/blob/develop/reference/zilla.yaml/binding-http-kafka.md

@jfallows Do you want to address all of this on this PR or make a separate one to do more review and try to find any more of these types of issues?

@vordimous i'm expecting you to address the feedback provided in this PR please.

vordimous commented 1 year ago

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-amqp.html#route AMQP binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-http-filesystem.html#configuration HTTP Filesystem binding has double back-ticks visible next to route link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-http-kafka.html#route HTTP Kafka binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-http.html#route HTTP binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-kafka.html#route Kafka binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-mqtt.html#route MQTT binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-proxy.html#route Proxy binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-sse-kafka.html#route SSE Kafka binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-sse.html#route SSE binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-tcp.html#route TCP binding route property has double back-ticks visible next to when condition link.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-tls.html#route TLS binding route property has double back-ticks visible next to when condition link.

Back ticks removed.

vordimous commented 1 year ago

https://aklivity-docs.pages.dev/zilla/next/reference/zpm/ zpm help is linked to clean command (existing bug)

https://aklivity-docs.pages.dev/zilla/next/reference/zilla/ zilla help is linked to clean command (existing bug)

There is no help.md file to point the links at.

vordimous commented 1 year ago

Please remove Contributors from footer and leave the last updated timestamp.

Contributors removed

vordimous commented 1 year ago

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding.html Clicking on each type of binding, such as amqp, loses left side navigation. Note link is of the form https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-amqp.html, whereas https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-amqp/ retains the navigation, even though it resolves to the same final URL. Also, briefly see a 404 page before it recovers to show the naked binding config page without the left side navigation, with unexpected "centered" layout.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding-amqp.html#configuration Clicking on route in properties briefly shows 404 then reloads and renders page with different "centered" layout instead of scrolling down to route property on the same page. This issue seems to be caused by the link being of the form binding-amqp.md#route in an html table, being left untransformed by the rendering process.

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/binding.html#configuration I'm seeing some visual artifacts in the rendering, such as how filesystem binding type renders differently in the list of available binding types.

All of the extra artifacts and link 404 errors along with the .md vs .html file differences are due to GitBook's rendering of markdown tables. The tables are a mix of markdown and html syntax. This is through the files and needs to be addressed separately.

Please enhance the link checking to ensure no .md links are left in the rendered HTML.

Will add this check to the link checker in the effort to clean up all of the links.

vordimous commented 1 year ago

https://aklivity-docs.pages.dev/zilla/next/reference/zilla.yaml/ Title changed from Zilla Runtime Configuration to Config Yaml. Title changed from Zilla Manager CLI to Manager CLI. Title changed from Zilla Runtime CLI to Runtime CLI.

Changed the names back.

vordimous commented 1 year ago

updates where deployed to GH pages: https://vordimous.github.io/zilla-docs/next/

jfallows commented 1 year ago

@vordimous Please address all the feedback in this PR before we merge.

jfallows commented 1 year ago

@vordimous per our discussion, let's merge this one for the sake of sorting out the CD and then you can fix up the markdown to make sure the new site is equivalently functional to the current GitBook site to switch over.