geocodes_documentation

Geocodes Documentation on Github io

This repository wraps/brings information for multiple repositories. The mkdocs.yml controls the rendering

flowchart 

    subgraph geocodes_documentation Repository
        D{mkdocs.yml}
        o(geocodes_documenation/docs)
        subgraph Geocodes Docker Container Repository
             gc{mkdocs.yml}
             gc2(deployment)
             gc3(production)
             gc4(indexing)
        end 

        subgraph Earthcube Utilities Repository
             ecu{mkdocs.yml}
             ecu2(earthcube utilities)
             ecu3(summarize)
             ecu4(notebook proxy)
        end 

        o3(gleaner)
        o4(metadata)
    end

Loading

The multi-repository approach means that this top level repository is not updated when a lower repository is updated, so you may find more recent updated in the repositories.

• Geocodes Docker Container Documentation
• Earthcube Utilities Documentation

It also pulls in information from

• Gleeaner (JSON-LD collection and Graph Loading)
• Earthcube Metadata
• Science on Schema

Adding to The Documentation

To add a repository to this GH Pages,

• clone
• uses .github/workflows/runscript.yml
• add to mkdocs.yml/multirepo/repos the new repo

      - Services Infrastructure: '!import https://github.com/earthcube/geocodes?branch=main&docs_dir=docs&config=mkdocs.yml'

You can also link directly to pages.

      nav_repos:
        - name: geocodes
          import_url: https://github.com/earthcube/geocodes?branch=docs&docs_dir=docs&config=mkdocs.yml
          # NOTE USING THE DOCS BRANCH
          imports: [ docs/data_loading/setup_indexing_with_gleanerio.md, docs/data_loading/install_glcon.md ]

and

-indexing
      - Load Data:
          - Install tool glcon: geocodes/docs/data_loading/install_glcon.md
          

Testing Updated Documentation

Using the MkDocs plugin: https://github.com/jdoiro3/mkdocs-multirepo-plugin

Install the requirements, and run from cli with

mkdocs serve

see docs/developers/addingdocumentation.md

=====

This repository is for documentation on the GeoCodes technology stack and production operation of the Gleaner-Nabu-GeoCodes UI workflow.

• Crawling and indexing the metadata, with gleaner
• Faceted search page
• utilities
• Testing the metadata as it goes through the stack
• GeoCODES container stack
• Editing json-ld descriptions of resources, with forms
• Onboarding a new repository