neo4j-migrations icon indicating copy to clipboard operation
neo4j-migrations copied to clipboard

docs: migrate documentation to Antora

Open ggrossetie opened this issue 3 years ago • 2 comments
trafficstars

ggrossetie avatar Sep 22 '22 16:09 ggrossetie

Sweet. I'll most likely do this in combination with the bump to version 2.

This way I can

  • keep the old versioned docs and also maintain the than 1.13.x or 1.14.x branch
  • you touch me about Antorra and how to publish it with Neo4j-Labs.

Wdyt?

michael-simons avatar Sep 27 '22 08:09 michael-simons

Sounds good 👍🏻

ggrossetie avatar Sep 27 '22 09:09 ggrossetie

I have really issues with duplication migrations.xsdand a bunch of other files. Right now, documentation is source and source is docs. I will definitely forget updating the copy. Can this be solved different?

michael-simons avatar Nov 10 '22 13:11 michael-simons

I don't understand why even the top level README.adoc is duplicated. How should I maintain it in a sensible fashion?

michael-simons avatar Nov 10 '22 13:11 michael-simons

I have really issues with duplication migrations.xsdand a bunch of other files. Right now, documentation is source and source is docs. I will definitely forget updating the copy. Can this be solved different? I don't understand why even the top level README.adoc is duplicated. How should I maintain it in a sensible fashion?

They are not duplicated, we are using symbolic links. Antora does not add files that are outside of the documentation component (i.e., outside the docs directory) into the content catalog.

Let’s consider one of the most common uses for the symlink feature in Antora. You have example files you want to include in your documentation, but those files don’t live inside the standard Antora directory structure. In order to make them available to Antora, you need to remap them into the Antora hierarchy.

https://docs.antora.org/antora/latest/symlinks/#remap-files-using-symlinks

ggrossetie avatar Nov 10 '22 18:11 ggrossetie

@all-contributors please add @Mogztter for code, doc

michael-simons avatar Nov 11 '22 13:11 michael-simons

@michael-simons

I've put up a pull request to add @Mogztter! :tada:

allcontributors[bot] avatar Nov 11 '22 13:11 allcontributors[bot]

I've put up https://github.com/michael-simons/neo4j-migrations/pull/731 to add @Mogztter! 🎉

Thanks! Good bot 😄

ggrossetie avatar Nov 11 '22 17:11 ggrossetie