28 use jekyll theme #43
Conversation
to generate the desired navigation
Missing part for deciding which part of the documentation is relevant for you.
Update _config.yml for search
Update index.md
as create or update workflow is not allowed using personal access token
Add workflow from master
Change callout for notes #28
Bring the documentation to status of Fix Release 1.0.0 https://github.com/metafacture/metafacture-fix/releases/tag/1.0.0
There was a problem hiding this comment.
Looks great!
Added inline suggestions, mostly to fix relative links for the deployed location.
Additionally, links to the feature branch should be updated from 28-use-jekyll-theme to master before merging. I did not add suggestions for these to keep the links in the deployed version working, as it's not merged yet.
Co-authored-by: Fabian Steeg <[email protected]>
docs/LICENSE.md
Outdated
|
|
||
| MIT License | ||
|
|
||
| Copyright (c) 2022 just-the-docs |
There was a problem hiding this comment.
I think the LICENSE here is confusing, since it's the Just the Docs license, not the Metafacture license (which is Apache 2). I think this can be removed here, or replaced with (a link to) the Metafacture license: https://github.com/metafacture/metafacture-core/blob/master/LICENSE
There was a problem hiding this comment.
Thanks. I move the old LICENSE file up to root level and added the link to the MF License in the Navigation.
Co-authored-by: Fabian Steeg <[email protected]>
Co-authored-by: Fabian Steeg <[email protected]>
@Phu2 redid the documentation, so that it works with the jekyll template. This changes the structure of the repo.
The markdown files are not at the toplevel anymore, but now in the
/docsfolder and its subfolders.Additionally I adjusted the README.md to fit the new structure.
We still should move and redo the maintainers guide so that it is not a page in the documentation. And document how to update the documentation but this can be done in a separate issue.
@fsteeg and @dr0i could you have a look. The render page also can be found here: http://metafacture.github.io/metafacture-documentation/