From acfc2840cbcff74302984463a9b08677d6016252 Mon Sep 17 00:00:00 2001 From: "david.blasby" Date: Wed, 18 Sep 2024 16:13:27 -0700 Subject: [PATCH] added documentation --- docs/README.md | 0 docs/manual/README.md | 0 docs/manual/docs/index.md | 17 ++ docs/manual/docs/ogcapi/catalog.md | 41 +++++ docs/manual/docs/ogcapi/conformance.md | 4 + docs/manual/docs/ogcapi/index.md | 15 ++ docs/manual/docs/ogcapi/landingpage.md | 26 +++ docs/manual/docs/ogcapi/openapi.md | 4 + docs/manual/docs/ogcapi/record-collection.md | 7 + docs/manual/docs/ogcapi/record-collections.md | 11 ++ docs/manual/docs/ogcapi/record.md | 6 + docs/manual/docs/ogcapi/records.md | 4 + docs/manual/mkdocs.yml | 152 ++++++++++++++++++ .../overrides/.icons/geonetwork/logo.svg | 28 ++++ .../overrides/.icons/geonetwork/logo_bw.svg | 15 ++ .../assets/images/geonetwork-logo.png | Bin 0 -> 6172 bytes .../assets/images/geonetwork-logo.svg | 21 +++ .../overrides/assets/stylesheets/extra.css | 79 +++++++++ docs/manual/overrides/main.html | 6 + docs/manual/overrides/partials/copyright.html | 41 +++++ docs/manual/pom.xml | 108 +++++++++++++ docs/manual/requirements.txt | 5 + docs/manual/src/assembly/guide.xml | 13 ++ docs/pom.xml | 45 ++++++ 24 files changed, 648 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/manual/README.md create mode 100644 docs/manual/docs/index.md create mode 100644 docs/manual/docs/ogcapi/catalog.md create mode 100644 docs/manual/docs/ogcapi/conformance.md create mode 100644 docs/manual/docs/ogcapi/index.md create mode 100644 docs/manual/docs/ogcapi/landingpage.md create mode 100644 docs/manual/docs/ogcapi/openapi.md create mode 100644 docs/manual/docs/ogcapi/record-collection.md create mode 100644 docs/manual/docs/ogcapi/record-collections.md create mode 100644 docs/manual/docs/ogcapi/record.md create mode 100644 docs/manual/docs/ogcapi/records.md create mode 100644 docs/manual/mkdocs.yml create mode 100644 docs/manual/overrides/.icons/geonetwork/logo.svg create mode 100644 docs/manual/overrides/.icons/geonetwork/logo_bw.svg create mode 100644 docs/manual/overrides/assets/images/geonetwork-logo.png create mode 100644 docs/manual/overrides/assets/images/geonetwork-logo.svg create mode 100644 docs/manual/overrides/assets/stylesheets/extra.css create mode 100644 docs/manual/overrides/main.html create mode 100755 docs/manual/overrides/partials/copyright.html create mode 100644 docs/manual/pom.xml create mode 100644 docs/manual/requirements.txt create mode 100644 docs/manual/src/assembly/guide.xml create mode 100644 docs/pom.xml diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/manual/README.md b/docs/manual/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/manual/docs/index.md b/docs/manual/docs/index.md new file mode 100644 index 00000000..86de52fd --- /dev/null +++ b/docs/manual/docs/index.md @@ -0,0 +1,17 @@ +--- +hide: + - navigation +--- + +# GeoNetwork MicroServices {#toc} + +Welcome to GeoNetwork MicroServices. + +
+ +- :fontawesome-solid-signs-post: [OGCAPI-Records](ogcapi/index.md) + + --- + + Implementation of OGCAPI-Records. +
\ No newline at end of file diff --git a/docs/manual/docs/ogcapi/catalog.md b/docs/manual/docs/ogcapi/catalog.md new file mode 100644 index 00000000..199a540c --- /dev/null +++ b/docs/manual/docs/ogcapi/catalog.md @@ -0,0 +1,41 @@ +# Catalog.yaml definition {#toc} + + +See [Catalog Definition in the OGCAPI specification](https://docs.ogc.org/DRAFTS/20-004.html#req_records-api_catalog-response). + +The properties come from the source's (portal sub-portal) in the GeoNetwork "sources" table, column "serviceRecord". +This can be configured in the `GN GUI: Admin Console-Settings-sources` for sub-portals. + +There is no GUI to set this for the "main" portal - do this in GN GUI: Admin Console-Settings-Settings-Catalog Service for the Web (CSW)-Record to use for GetCapabilities (`system/csw/capabilityRecordUuid`). + + +|Property| Description | Elastic Index JSON Property | +|--------| ----------- | --------------------------- | +| id | A unique identifier for this catalog. | metadataIdentifier| +| created | The date this collection was created. | createDate| +| updated | The more recent date on which this collection was changed. |changeDate | +| conformsTo | The extensions/conformance classes used in this catalog object. | `not used` | +| type | Fixed value of "Catalog". | always "Catalog" | +| itemType | Fixed value of "record", "catalog" or both. | always "record"| +| title | A human-readable name given to this catalog. | resourceTitleObject| +| description | A free-text description of this catalog. | resourceAbstractObject| +| extent | The spatiotemporal coverage of this catalog. | spatial: geom
temporal: resourceTemporalDateRange | +| crs | A list of coordinate reference systems used for spatiotemporal values. | coordinateSystem| +| keywords | A list of free-form keywords or tags associated with this collection. |tag | +themes | A knowledge organization system used to classify this collection. | allKeywords| +| language | The language used for textual values (i.e. titles, descriptions, etc.) of this collection object. |mainLanguage | +| languages | The list of other languages in which this collection object is available. |otherLanguage | +| recordLanguages | The list of languages in which records from the collection can be represented. |`not used` | +| contacts | A list of contacts qualified by their role(s). |contact | +| license | The legal provisions under which this collection is made available. |MD_LegalConstraintsUseLimitationObject | +| rights | A statement that concerns all rights not addressed by the license such as a copyright statement. | `not used`| +| recordsArrayName | The name of the array property in the catalog used to encode records in-line. The default value is records. | `not used`| +| records | An array of records encoded in-line in the catalog. |`not used` | +| links | A list of links related to this catalog. | `filled with Java code`| +| linkTemplates | A list of link templates related to this catalog. | `not used`| +| schemes | A list of schemes related to this catalog. |`not used`| + +See `ElasticIndexJson2CollectionInfo.java` for more details. + +NOTE: For `Contact.address`, we only fill in the `deliveryPoint` because that's all that's available in the Elastic Index JSON. + diff --git a/docs/manual/docs/ogcapi/conformance.md b/docs/manual/docs/ogcapi/conformance.md new file mode 100644 index 00000000..d377e007 --- /dev/null +++ b/docs/manual/docs/ogcapi/conformance.md @@ -0,0 +1,4 @@ +# Conformance {#toc} + + +See [Conformance in the OGCAPI specification](https://docs.ogc.org/DRAFTS/20-004.html#conformance_class). diff --git a/docs/manual/docs/ogcapi/index.md b/docs/manual/docs/ogcapi/index.md new file mode 100644 index 00000000..0703666f --- /dev/null +++ b/docs/manual/docs/ogcapi/index.md @@ -0,0 +1,15 @@ + +# GeoNetwork MicroServices OGCAPI-Records {#toc} + + +This service module implements the ([OGCAPI-Records](https://ogcapi.ogc.org/records)). + +| Endpoint Name | Endpoint Location | Meaning | +| -------- | ------- | -------- | +| [Landing Page](landingpage) | / | Home Page | +| [Conformance declaration](conformance) | /conformance | Conformance Documents | +| [OpenAPI Documentation](openapi) | /openapi | OpenAPI (Swagger) description document | +| [Record collections](record-collections) | /collections | List of Catalogs
(GN portals) | +| [Record collection](record-collection) | /collections/{collectionId} | Information about a single Catalog
(GN portal) | +| [Records](records) | /collections/{collectionId}/items | Records in a Catalog
Search, etc... | +| [Record](record) | /collections/{collectionId}/items/{recordId} | Single Metadata Record | \ No newline at end of file diff --git a/docs/manual/docs/ogcapi/landingpage.md b/docs/manual/docs/ogcapi/landingpage.md new file mode 100644 index 00000000..b79f840e --- /dev/null +++ b/docs/manual/docs/ogcapi/landingpage.md @@ -0,0 +1,26 @@ +# Landing Page {#toc} + +The Landing Page will show information about the server. It has links to the [Conformance declaration](conformance), the [OpenAPI Documentation](openapi), and the [Record collections](record-collections). + +See [Landing Page in the OGCAPI specification](https://docs.ogc.org/is/17-069r3/17-069r3.html#_api_landing_page). + + +## JSON Model + +The JSON model follows the ["landingPage.yml"](https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/landingPage.yaml) definition in the OGCAPI Specification. + +| JSON Tag| Meaning | +| -------- | ------- | +| title | Title for the server | +| description | Description of the server | +| links | Links to other documents | + + +The GeoNetwork OGCAPI-Records implementation also include a non-standard item: + +| JSON Tag| Meaning | +| -------- | ------- | +| systemInfo | Metadata for the Server. See the [catalog.yaml](../catalog) description. | + + +This metadata information is taken from the Service Record linked to the GeoNetwork's main portal. diff --git a/docs/manual/docs/ogcapi/openapi.md b/docs/manual/docs/ogcapi/openapi.md new file mode 100644 index 00000000..3c229492 --- /dev/null +++ b/docs/manual/docs/ogcapi/openapi.md @@ -0,0 +1,4 @@ +# OpenApi Description Document {#toc} + +This is the [OpenApi (Swagger) Description Document](https://swagger.io/). + diff --git a/docs/manual/docs/ogcapi/record-collection.md b/docs/manual/docs/ogcapi/record-collection.md new file mode 100644 index 00000000..7c6d18a2 --- /dev/null +++ b/docs/manual/docs/ogcapi/record-collection.md @@ -0,0 +1,7 @@ +# Record Collection {#toc} + +See [Record Collection in the OGCAPI specification](https://docs.ogc.org/DRAFTS/20-004.html#clause-record-collection). + +##JSON Model + +See the [catalog.yaml](../catalog) description. \ No newline at end of file diff --git a/docs/manual/docs/ogcapi/record-collections.md b/docs/manual/docs/ogcapi/record-collections.md new file mode 100644 index 00000000..7dcfe581 --- /dev/null +++ b/docs/manual/docs/ogcapi/record-collections.md @@ -0,0 +1,11 @@ +# Record Collections {#toc} + +This gives a summary of all the Record Collections (Catalogs) on the Server. In GeoNetwork this is the main portal, plus any sub-portals described. + + +See [Record Collections in the OGCAPI specification](https://docs.ogc.org/DRAFTS/20-004.html#record-collections). + + +## JSON MODEL + +See the [catalog.yaml](../catalog) description. \ No newline at end of file diff --git a/docs/manual/docs/ogcapi/record.md b/docs/manual/docs/ogcapi/record.md new file mode 100644 index 00000000..52985c11 --- /dev/null +++ b/docs/manual/docs/ogcapi/record.md @@ -0,0 +1,6 @@ +# Record {#toc} + +See [Record in the OGCAPI specification](https://docs.ogc.org/DRAFTS/20-004.html#clause-record-core). + + + \ No newline at end of file diff --git a/docs/manual/docs/ogcapi/records.md b/docs/manual/docs/ogcapi/records.md new file mode 100644 index 00000000..0c259aeb --- /dev/null +++ b/docs/manual/docs/ogcapi/records.md @@ -0,0 +1,4 @@ +# Records {#toc} + +See [Records in the OGCAPI specification](https://docs.ogc.org/DRAFTS/20-004.html#clause-record-collection). + diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml new file mode 100644 index 00000000..73c44668 --- /dev/null +++ b/docs/manual/mkdocs.yml @@ -0,0 +1,152 @@ +# Project information +site_name: GeoNetwork Opensource Microservices +site_description: GeoNetwork Opensource Microservices. +site_dir: target/html +site_url: https://docs.geonetwork-opensource.org/ + +# Repository +repo_name: geonetwork-microservices +repo_url: https://github.com/geonetwork/geonetwork-microservices +edit_uri: edit/main/docs/manual/docs + +# Copyright +copyright: Copyright © 2024 FAO-UN and others + +extra_css: + - assets/stylesheets/extra.css + +# Configuration +theme: + name: material + language: en + custom_dir: overrides + logo: assets/images/geonetwork-logo.svg + favicon: assets/images/geonetwork-logo.png + icon: + repo: fontawesome/brands/github + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue + toggle: + icon: material/weather-night + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/weather-sunny + name: Switch to light mode + features: + - toc.follow + - navigation.tracking + - navigation.top + - navigation.tabs + - navigation.prune + - navigation.indexes + - navigation.footer + - header.autohide + - content.tabs.link + - content.code.copy + - content.action.view + - content.action.edit + - announce.dismiss + +# Plugins - install using: pip3 install -r requirements.txt +plugins: + - exclude: + glob: + - annexes/gallery/bin/README.md + - i18n: + docs_structure: suffix + reconfigure_material: true + languages: + - locale: en + name: English + build: true + default: true + site_name: 'GeoNetwork MicroServices OpenSource' + - locale: fr + name: Français + build: !ENV [FRENCH,true] + site_name: 'GeoNetwork MicroServices OpenSource' + site_description: Catalogue GeoNetwork pour répertorier, rechercher et examiner les enregistrements. + nav_translations: + Home: Home + Search: Search + Record: Record + Map: Map + - search + +# Customizations +extra: + version: + provider: mike + default: stable + alias: true + homepage: https://geonetwork-opensource.org/ + social: + - icon: fontawesome/brands/github + link: https://github.com/geonetwork + - icon: fontawesome/brands/docker + link: https://hub.docker.com/_/geonetwork + - icon: geonetwork/logo_bw + link: https://geonetwork-opensource.org/ + name: GeoNetwork Website + +# For use with --strict to produce failures on build warnings +validation: + nav: + omitted_files: warn + not_found: warn + absolute_links: warn + links: + not_found: warn + absolute_links: warn + unrecognized_links: warn + +# Extensions +# - These are carefully chosen to work with pandoc markdown support for whole document translation +markdown_extensions: + - admonition + - attr_list + - def_list + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + options: + custom_icons: + - overrides/.icons + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.smartsymbols + - pymdownx.snippets + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - tables + - md_in_html + +# Page tree +nav: + - 'GeoNetwork MicroServices': index.md + - 'OGCAPI-Records': + - ogcapi/index.md + - ogcapi/landingpage.md + - ogcapi/conformance.md + - ogcapi/openapi.md + - ogcapi/record-collections.md + - ogcapi/record-collection.md + - ogcapi/records.md + - ogcapi/record.md + diff --git a/docs/manual/overrides/.icons/geonetwork/logo.svg b/docs/manual/overrides/.icons/geonetwork/logo.svg new file mode 100644 index 00000000..d1ebaec7 --- /dev/null +++ b/docs/manual/overrides/.icons/geonetwork/logo.svg @@ -0,0 +1,28 @@ + + + + gn_logo + Created with Sketch. + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/manual/overrides/.icons/geonetwork/logo_bw.svg b/docs/manual/overrides/.icons/geonetwork/logo_bw.svg new file mode 100644 index 00000000..61c0c2d9 --- /dev/null +++ b/docs/manual/overrides/.icons/geonetwork/logo_bw.svg @@ -0,0 +1,15 @@ + + + + gn_logo + Created with Sketch. + + + + diff --git a/docs/manual/overrides/assets/images/geonetwork-logo.png b/docs/manual/overrides/assets/images/geonetwork-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f8926bf7e122052a8f7cfc57ccd64294efdce3fa GIT binary patch literal 6172 zcmV+%7~|)OP)00001b5ch_0Itp) z=>Px#L}ge>W=%~1DgXcg2mk?xX#fNO00031000^Q000001E2u_0{{R30RRC20H6W@ z1ONa40RR91N1y`$1ONa40RR91MF0Q*0InmkivR!@hDk(0RCodHTzha`#d$w_&bdcd z@24$Wk}WV8Fb+?H9}r#*NoSIwP1><(Nt4=+feCpOCQZkk%mn|@khJ5FY12SS95A#= z2?o-cz%a=`Ob8g;*gOp8VPhLhvTPyiVe9H~?|E#0zi-dEx{@XNB>`!=@}7NtyZe2= z{dV`;bM{(UAFNZe7p<75m357_tn;+unwUyp$YB{q z_d7GLTEQtf>CTz-7UKp>YA@L8rc?>0(|lwVO-(;)N2K&E2RE&MWh&aAvT2nt+pyr4 z5<3-KV@1|A$h*i=nqW1+pX|W&1L!?isCU3`vm^a<%S#XLO!}FMaLU0Mlj&>MxD9=K z8yuCYh@7y@igc;%IHe4+cn8Y1Gb&X5$`1O2(8<^-)!FvqPrJu#>;E%990aCZb2e_g z*3ER<_0WnsTZNUdajKM)tyJ2sw3I4RTBnegvfW%tA=HtI5c*;0`q-|0l=;fCGlB0O zQQGRYb#x>MQoY$C=g_icPal~|*d_&>#~=J$Z7}4{vt0jN*UOy?gY6vG%{3`YH9+Wk z7&zZ-ky1| z>)q?tJR6K?;3N|XpC?uAp&zZ9XGg*H%JmmRICy^!8*rSQ2rEKM+?RF}005Mv0h)wK z8sJGf|A6XwBD~mu%98?TZXD|xAZIQAzBmP3MDt>0!S5D4g zJYjIw-F@5Ht_p93pnndb=91F{3~GZ23K9B_IG4h6I5jg(FZBN4t#E*=`mtVvO5%qGzmXcDtWXbxyinF%!-BtS_X0B%S8 zuA5ii{Uh=-o|_PyfBUC97M2zTPeRx_3Y-_#$;!yP0tB=sPU8?M+9X9{qU5XeUlff9R8a%fJ-Sv0lo{ zu><~D`ULk}}KoP((JyUUeNq(N6 zQ9LC5lP@|>OYtUU`GGa`)&c*{hQ)t-rDTnIj0w)H#Vc-vs@$}g>%Vx+8Qt|U+|*zAg;G@beoUxd*{2r1 z(c-m!;!@pl{U!YudT!1mAU3^#M6F2{UNTC+OvsgzGzx+hx|WVQ7=F|g=3>I~pUqb_ zV~$l}RijnNQ4m@dX!Madt|bH_zh<$3<>F0uoqbNvqt7{eceUz|p~GsDfQ>UOH@6zm zZ!?{^W599K?mwcikpyIy4d--f)>E&fXFc^=^I=!oqFMU9p_B1_A3M!&?Fkf zG&PJP$dMk)b!EycWJ*P$rLpGN8gwv7a3~#%e9SyfH?G?RDRGG~C_$EKD@403oh64~ zc)e=>_P0x``iJbZP`E%yl8OjnR{TBQL9J`w{!mMjowO(E#zm`O)rQ}Y1bXHlY+I)Lx=qaT=w3YIGjkt?= zRAJi+qpqtk-Kt@kPX`taSdE(Ywp2CmZL7$=xu>>&PisZG>xg$I2AOXkkM{<$*mmr@ zK=(H>Gb8b9T(n{>Fpt3jAW(e)hdYXZ8JZyp4S|1-8sv@MJfp>=mQI-0w|HJ4@QGTiy$#~ z7iGYJP6{XjCh8Xhv~xjnE|rxoOc{Q0XcUFfNGePv0hOSDjDA>yq}qr_Q=5gYO}&^5 zrx+LLB(af35TAO&b;9TlRKJ}~=8LwqF7vX;(mt9B#wO zwhXKRsHvOKA2X}!iyH=k;J`S=lbOA$?#h+rY%mWF=H(YS ze1>r_8BZG-T{50{RFWwr5c|rMbH#LJE+HU<65~AvGt~I2w6k z=*1dEu%KyqpyN8p0GLS_cRFUEx`c@_%O)=q82mL`lQk!df@NelFBGR1Jl7lM%X+}_ zWOO;g^a29P@n@z|tcV0s>KSpd2m@8K!Lm~^5hNs`5tlKOlB_Ww;Ex~sEJd>k>(>;z zPtN}MP1OPpq>rVF8KriN0z*_D`2REnpG(Hu@01D?^g z0*#9EN77Rx6CY2vWNIc0b*!lqEy$D@TX&yn8~qc|sdJCEZCSrtz&WsGU0dMlMKH9U zlhMvIAA=wh2a`v@!b60`Zbi^I89*;<5%UYz7{rsqCF?|v*{x)4lBqZf=wSsOTWmWu zm>)42xv|MkBbVm(+R9Ak^K8TDKO!B^t=os-n#SwC_8EkCK;%Dx2I2iTMhsIxb{ko9 zVn8_eL1?rno?fD10F-qAMl!gOMx6ExhXR$%asi?cwhlVL1TzK45m;N%Ao)-sre)ke zDo%#WVAWg~S?>3#C~a|zZqt&b#bQIm83#80@JU3UZ1~i-W`XOaP~*=)XRZPi<_(kV zNW;^_Xc465)Bqq%6C4RCGab_m;xq%v!h-`zWb^A(? zU4l`&0RAihV9P=sgCcRN2PH;cvY#+ZrX4gzz#uyC-0(;w9Y+DOSTMfB$PU^TU&pcr zhD#b7!S;BSiQ+C$Zbg+%j^(_tfAhMxrIGP!Am7EOj2j!TxMgw9bH6;^b&mF5t)XSQ zG4|42!wvV9WGjOC0O10Nc_xIPjm2j+G!17R)dVf_k_A>{8qf(y3<(THkP7Nq?Z3K}fV~v^!Xm`AD!pw(y|TPo2vP0g1dZ==)mDg; zw6bb6KKnudynL}e2;eC#FNLvM%f+QpZ51Q~`+2N8w_|&lcw?+J1swkIL{-z`l{vho#3&})Fc(`auH2bY z9zHWTFTh%U9^ocsd#`l-@|*AfvA_dxRt;#Sie;xsL9+o8fuc`N+{QQ*u&_KhodE9* z0Jbyoyf48y{ty;z-^u#EucDk2 z4f<{r`B^oX^ZW|D*6Yme+;As$7#_+#JO|DB(k=)!SByOD7+iNEIaC_$5#b4h5gs9c za*Ohy8IS;sSjGla+0rQ!Ep0k%;dJumkLM|F=`afI5Zf}(TinLE1JO_na`|c)z{4KY>#?=&LCyD-ids};x8z*ErDM~7cA~q}1{P>UxW<8z zm)6i8n92*qOfpGL;*Oj2$2`VGYnX2Y$L$Is5&MNvd>A5l6r4^DnrxpZba-Q~7)zS~ zv9A#lMIr1kc&ROVGz|cuzUhehj0rDb5N9td6}nc_q7^jgTH$wtVh4y`SCO-0x^~{# zzWv9vc}~c=XnYTtzl`6GXoQhfVLXu#&4`^shM+NI#V~~@HGF*Soa|EUkOGq#&I&%rF+A1X6iN+f1)z-WI93r}8Ht?; zia6yIP}mFwX0h2uNz&IF?GZ*M77=fZSEbU19c#!_&9p1iKm!aRw5Z+NV zIGAf%xbnAJML*Yp_gMS(AJcZrJEy$q65b+TmVc!~hA@qAFApr5>6TE7xlT(q21@}r z(vfRc6G2QM!iY5Bgr`>lhh@|fY8>O#8u1X8NF}tes7Yr4BUq>t_o3qHSEyOi*r`1r zfOR&s@N@X^_~nXOmzEUQeC(zEjvX@fa2HW;L&sPyI3%&UlKDi9MQWCEG(jTF8O9Ul zr7Gz;nxYxdupo>52p{(7x$q|WsGkQ#0KgSVX>&N=@Pf|RH+{^H^evqsZ}MFY1iaHN zcHd}PvK&Vu(=`^b<==%0td{MXyHdP`8~es=hdiD9IGc0~JrVWC739 zQTter?MxjoY`Fs8z#ksb$Fys2D@$dA<;t;d#^_&|w_Ug>QyXHtC9h$z27%jHgOYb= zCOra7YDg@SfIt>xI>FwFf#M>ZXovtJQ*l_k>;Ovv+adi_I&F2fl{7bu0H?6OnOEO7 zPdV-l_%{9N5btsTPP%XkB~wa3qtKjY{6lCokB|W*xFjtg3P{ML*03JKB##=yIM*12 z323;Eg{r1Z%0)}1>8W`r>)+cpKk&72!71!@{?avGZ+B)vWIIc6G`JX?UIZ}kyD2A? zUteNy@?fEXr11nKfr-MSAP)%B^mNHCHA-WWX(x13tuPjSzN zca7&cK~HlQZ`xC^Jry?ol61~mcvic$Jz&Hk+`+jiy%(NbOGz|PJc+-kYpM$HivV6e!OKx;Z znoA12Sy>QAxuam$;9?P7Q7T(9y^0>kw<&O$fuf$aLuK!`v{&`+Z?DYmZ?DyDhssNj z^m(%)t?Ey{OTDkPx&IMstEqVmI8N5NEpWXnQWk%DK*{l9GKkMqw2WiNm{`nlo|Fh! zyntEXY^tX$2D5Ha%-;G_8ckgerI3x{%vp79(jFFd3FCF zetv*EK@&5gzHM#TkZ1ZBaQZUYjb)W;HSX-@Ps7v*E}}eHaZe&(=5J(L8Z)Q~511e$ zrrE@doqVZ|jIn91^Yb3ExroiMJZ;xpJa?ex!ZZ1e>yVY{EAQX7tNhicw^sz6y^3e6 zkwD=GwryJ<_*o$rruBlHUq82XUvJSxRSlKyjFKW=EsGs6;q6eaDViVYh!-9P3rPqe z({#c(%jFUQKEzGpdn;)hH=w93fsaK{R@(ayFTV2}orGU;%-`>kxp0E%LNL;-J8w0tmP;g?01n82>hb2{I;`LOTr7 zi2{X-mO$6|VNmcUlG*|=1PFk}tNjUB!b4m}Z5r09B8d|;<~LNQXYFhY9!qs)zS`OO zW`3<`>{0Fq+)-ebMO454w^qQczdHRr^)0i!t({QwYMqQ>67oce(F3EZ+J9JVh7*BTSrrgMNZH=E3 z=v2zZ_fto^uy*);p6|Yl1|mUWMR;l?z)hwMJ5MyHFh5y`2%-U%3wIGOK|LPo^!IN5 z=GuL%JC>Ue99C#r^2J8X@8>~y##jwZaUPXu5TAiFIGyynb~sq%>3)DaR9zkf)2ef- zxjvU}s`Kk+*5(?qFyoD`m%%t?5cUJeK7eui({VU2E2?IqvE8 zxZqIu*_W@J6WJOXBtLm()<@A{%~1F$wcZAW+M2TUuix9e{=L&-^n}1+2MtS>pJzwv zcZg0uoen?9x)APVY>*G8tIO_t_o*Mk%s)AI!r-u3YEWqFCs2vj<{y%K6+d^pa`X%I z;|YL0^2A-sOZV?hW%U)jp(E7cz1dEftS{AK3OJDYFdqM{ETatr~Ls7Zwu`kun=B{@}|)=A8uMdma^Qh z?Ax-g<5c)KEpSG6IP;1xHM?PSG4@~lhaUK0h_>dypN06e(X>;XK7{wtUq7&Q{f5)& zXHvl#j}aP^JtbxJIEBrC$ybN35d3c&%JK8T3Vf0%#%p!H0Z75(b+HXQJenZHHz8c# z!0iASef(CP#yhq&=qk_;55zO!8{rGzEa2x%dTp+_ + + + + + + + + + + + + + + + diff --git a/docs/manual/overrides/assets/stylesheets/extra.css b/docs/manual/overrides/assets/stylesheets/extra.css new file mode 100644 index 00000000..07b39e34 --- /dev/null +++ b/docs/manual/overrides/assets/stylesheets/extra.css @@ -0,0 +1,79 @@ + +img + em, .browser-border + em, .browser-mockup + em { + display: block; + text-align: left; + font-size: 0.7rem; + font-style: normal; +} +.md-typeset .admonition, .md-typeset details { + font-size: 0.75rem; +} + +/* definition list used to display general inputs */ +.md-typeset dl dd { + margin: 10px 0; +} +[dir=ltr] .md-typeset dd { + margin-left: 0; +} +.md-typeset dl dd code { + border: 1px solid rgba(230, 230, 230, 0.7); + padding: 8px 12px; +} + +.browser-border { + border: 1px solid rgba(230, 230, 230, 0.7); + border-radius: 3px; + background: #fff; + margin: 10px 0 5px 0; +} +.browser-mockup { + border: 1px solid rgba(230, 230, 230, 0.7); + border-top: 2em solid rgba(230, 230, 230, 0.7); + /*box-shadow: 0 0.1em 1em 0 rgba(0, 0, 0, 0.4);*/ + position: relative; + border-radius: 3px; + margin: 10px 0 5px 0; +} + +.browser-mockup:before { + display: block; + position: absolute; + content: ''; + top: -1.25em; + left: 1em; + width: 0.5em; + height: 0.5em; + border-radius: 50%; + background-color: #f44; + box-shadow: 0 0 0 2px #f44, 1.5em 0 0 2px #9b3, 3em 0 0 2px #fb5; +} + +.browser-mockup.with-tab:after { + display: block; + position: absolute; + content: ''; + top: -2em; + left: 5.5em; + width: 20%; + height: 0; + border-bottom: 2em solid white; + border-left: 0.8em solid transparent; + border-right: 0.8em solid transparent; +} + +.browser-mockup.with-url:after { + display: block; + position: absolute; + content: ''; + top: -1.6em; + left: 5.5em; + width: calc(100% - 6em); + height: 1.2em; + border-radius: 2px; + background-color: white; +} + +.browser-mockup > * { + display: block; +} diff --git a/docs/manual/overrides/main.html b/docs/manual/overrides/main.html new file mode 100644 index 00000000..f2432066 --- /dev/null +++ b/docs/manual/overrides/main.html @@ -0,0 +1,6 @@ +{% extends "base.html" %} + +{% block outdated %} + GeoNetwork 4.4 is latest. + Click here to go to stable. +{% endblock %} diff --git a/docs/manual/overrides/partials/copyright.html b/docs/manual/overrides/partials/copyright.html new file mode 100755 index 00000000..40f52ada --- /dev/null +++ b/docs/manual/overrides/partials/copyright.html @@ -0,0 +1,41 @@ + + + +
+ {% if config.copyright %} + + {{ config.copyright }} + + {% endif %} + {% if not config.extra.generator == false %} + — Made by the + GeoNetwork Community, + built with + + Material for MkDocs + + {% endif %} +
diff --git a/docs/manual/pom.xml b/docs/manual/pom.xml new file mode 100644 index 00000000..e74e55a0 --- /dev/null +++ b/docs/manual/pom.xml @@ -0,0 +1,108 @@ + + + + + gn-ms-docs + org.geonetwork-opensource.cloud + 4.4.5-0 + + 4.0.0 + gn-ms-guide + GeoNetwork MicroServices Guide + pom + + + Creative Commons Attribution 3.0 License + http://creativecommons.org/licenses/by/3.0/ + repo + + + + + + + maven-antrun-plugin + 3.0.0 + + + + docs + compile + + run + + + + + + + + + + + + + + + + maven-assembly-plugin + 3.3.0 + + + make-assembly + package + + single + + + + + src/assembly/guide.xml + + + + + + + + maven-deploy-plugin + + true + + + + + maven-install-plugin + + true + + + + + + + + \ No newline at end of file diff --git a/docs/manual/requirements.txt b/docs/manual/requirements.txt new file mode 100644 index 00000000..f9aaca20 --- /dev/null +++ b/docs/manual/requirements.txt @@ -0,0 +1,5 @@ +mkdocs-material>=9.5.3 +mkdocs-static-i18n>=1.0.5 +mkdocs-include-markdown-plugin +mkdocs-exclude +mike==2.0.0 \ No newline at end of file diff --git a/docs/manual/src/assembly/guide.xml b/docs/manual/src/assembly/guide.xml new file mode 100644 index 00000000..58394d44 --- /dev/null +++ b/docs/manual/src/assembly/guide.xml @@ -0,0 +1,13 @@ + + manual + + zip + + + + target/html + + + + + diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 00000000..1d41005e --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,45 @@ + + + + + gn-cloud-microservices + org.geonetwork-opensource.cloud + 4.4.5-0 + + 4.0.0 + gn-ms-docs + Root Documentation module + pom + + + General Public License (GPL) + http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt + + + + manual + + \ No newline at end of file