Skip to content

Commit d2b8747

Browse files
User Manual refresh using Markdown and MkDocs (geonetwork#7329)
* online help ported from hnap manual * translate module from hnap prototype Expanded to convert from sphinx * Update help to match discussion * some sample pages to test translate script from rst to md * Testing translate pandoc rst to markdown * Changes to style and theme: - add browser window style - colors - add extension and features * pre/post * overview section * overview section * Changes to style and theme: - add browser window style - colors - add extensions and features * update translate rst command for directory processing * bulk covert change-log * api content * fix quickstart formatting * user-guide landing page * anchors lookup from rst files * example of fixing an broken anchor link * include version text to avoid i18n issue * Document include plugin for use to inline content from other files * Handle rst fenced blocks like note and warning (and deprecated and see also) * admin guide > managing metadata standards * Remaining admin guide pages * Review of admin-guide fixing common indenting rst mistakes These introduce random block quotes when none is intended * install-guide * contributing * tutorials * customizing application * special logic needed for admonition * maintainer guide * user guide update * Some updates to files corrected by hand earlier * anenxes * integrate into maven build * Work on reducing download size of manual * Fixing indents for lists and code blocks, and thus removing blockquotes in the resulting pages * Improve indents and TOC, add tabs, add copy to clipboard for code blocks and smart symbols, add extra text to the footer * Improve order and titles of pages * work on appearance # Conflicts: # docs/manual/mkdocs.yml * work on translating doc references # Conflicts: # docs/manual/docs/overview/index.md * work on index headings * back convert to rst any manual changes perofrmed to markdown * switch to preprocessing references * Second check of script generated conversion * restore change log pages, requires update of mkdocs-static-i18n>=1.0.5 * Fold in online help and clean up nav structure * update doc links to index.rst files * Update script to better handle links to index.rst files * small corrections from review with jose * recover mef docs from 2.10.x branch * index rst files for doc conversion * update anchors.txt index based on improved rst scan * remove help module, added as distinct assembly to manual * no parameter doc conversion * Version management with mike * Move translate script * update to toctree conversion with document titles * process reference links using anchors_txt index * script fixes for heading length, rst_epilog substitutions, and reference titles * clearn conversion, although warning while serving due to absolute links * change to generating relative links * clean up warnings * include version changes in title index * regenerat version changes now that we have references working * clean up gallery warnings * adjust nav * Fix numbering and admonitions on some pages, fixing some edge cases, adding language to code blocks * Fix arrows (-->) with `Smart Symbols` and add grid to startup page * Use less lines in the footer and fix the version toc * Fix the grid on the first page - remove the uneven gap * Update content structure and address feedback geonetwork#7363 * translate script removed to its own repository * langauge chooser by default * publish french to mike versions by default * Add suite_url so that language chooser works with mike versioning * update deployment and translation instructions * remove development feedback banner * Fix for the grid on the starting page, make it responsive * Change to major.minor examples and use of remote for docs.geonetwork-opensource.org publishing We will need to test edit link and other features once this is deployed * geonetwork icons * Add a gitignore include so that overrides/.icons is version controlled correctly * remove manuals submodule This was no longer included in the build * describe the repo as core-geonetwork in header * troubleshooting mike deploy * continue to troubleshoot mike deploy * working on mike instructions --------- Co-authored-by: Michel Gabriel <[email protected]>
1 parent 1579d52 commit d2b8747

File tree

744 files changed

+60742
-15
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

744 files changed

+60742
-15
lines changed

.gitmodules

-3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,3 @@
77
[submodule "web-ui/src/main/resources/catalog/lib/bootstrap-table"]
88
path = web-ui/src/main/resources/catalog/lib/bootstrap-table
99
url = https://github.com/wenzhixin/bootstrap-table.git
10-
[submodule "docs/manuals"]
11-
path = docs/manuals
12-
url = https://github.com/geonetwork/doc.git

docs/README.md

+9-7

docs/manual/README.md

+156

docs/manual/docs/_static/GN3.png

3.53 KB

0 commit comments

Comments
 (0)