Giter Site home page Giter Site logo

extend OGC harvester about doc HOT 2 OPEN

geonetwork avatar geonetwork commented on July 23, 2024
extend OGC harvester

from doc.

Comments (2)

fxprunayre avatar fxprunayre commented on July 23, 2024

Some info are available here
geonetwork/core-geonetwork#2774

I've one question about this type of doc page listing the form field and simple help text. In Angular app, we have been in quite some forms adding helper text. eg. those new parameters are quite well documented in the form
image

In such situation, does it make sense to copy/paste this to the documentation?
Maybe an approach would be to be sure that all application forms provides the help description for each fields so we don't duplicate efforts in the doc? The doc could be structured with:

  • context
  • optional screenshot of the form / video of the feature ?
  • additional note
    And from the application form we should provide link to the doc to get the context & notes about the features. One goal would be to remove redundancy of info app/wiki/pr/doc.

Maybe something to discuss during the documentation codesprint ? @archaeogeek you maybe have recommendations for that.

from doc.

archaeogeek avatar archaeogeek commented on July 23, 2024

Screenshot with additional explanation makes sense to me- no point in duplicating effort.

from doc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.