Code Monkey home page Code Monkey logo

docs's Introduction

TEKSI wastewater module (project QGEP)-Documentation

This is the documentation for the TEKSI wastewater module (QGEP project)

Resources

The final product can be found here:

Process

The documentation is written in English and managed in this git repository. The latest version of the documentation is automatically built using GitHub actions and published on the links above at every merge of a pull request.

Translation is done via transifex.

Contributing

TEKSI wastewater module is a community driven open source project. As such we are very happy to get your help and feedback.

Therefore we will be very happy if you can help us by

  • Documenting features (in English)
  • Improving the documentation (in English)
  • Translate it to your language

Documentation process

Note: You will need a github account for this.

Navigate to https://github.com/QGEP/docs and click the Fork link on the top right. You now have your own copy of the documentation on which you can work and cannot do any damage, feel free to experiment. If you want more information about forking you can find it here.

You most likely want to make changes to the files in the folder en. That's where all the real documentation text is located. The documentation is written in reStructuredText, a simple syntax to structure the text. You can find information about it in the reStructuredText Primer or by looking at what is already in the documentation and make your changes according to it.

Once you have made changes which you would like to contribute back to the main documentation, please make a pull request.

Translation process

Note: You will need to have a transifex account for this.

Navigate to our transifex project and click on the language you would like to translate. You will see a link Join Team. Click it and wait for approval (you will receive an email).

Once you receive the email you can head back to the transifex project page, click on your language again and then will have the possibility to choose a documentation chapter to translate. There is a Translate button after choosing a chapter.

If your language is not yet available, we will happily add it for you. Just open an issue and tell us which language you would like to translate it to.

docs's People

Contributors

3nids avatar decheu avatar kant avatar lbartoletti avatar m-kuhn avatar mdouchin avatar olivierdalang avatar ponceta avatar rbovard avatar schoeller avatar signedav avatar sjib avatar tproduit avatar triformmoritz avatar tudorbarascu avatar urskaufmann avatar varrieta avatar why-not-try-calmer avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Admin-guide Specify where to enter the commands and what to replace

Example: I need to add an extra field:
Description in chapter 3.42 - Adding fields

The views can be re-generated any time using the following command:
./view/create_views.py --pg_service pg_qgep --srid 2056

I need to know;

  • Where to enter the command (PG admin SQL? QGIS python line? osgeo4W shell? Python shell? On the QGIS computer? On the postgres computer?)
  • What to replace ( replace pg_qgpep with your database? replace view with the custon field?

This is an issue for me in the whole documentation.

Sample VM does not work

Hi, on my ubuntu 16.04 (lenovoX1 4 th gen), I can't run the virtual machine. debian startup shows and then I get a few errors and a dark screen. See attached log

VBox.log.zip

I hope that helps

restoring sample db fails to materialize network_segment view

usr/bin/pg_restore --host localhost --port 5432 --username "postgres" --dbname "qgep" --no-password "/home/regis/OSLANDIA/projets_locaux/QGEP/data-demodata/qgep_demodata.backup"

returns following errors:

pg_restore: [archiver (db)] Error while PROCESSING TOC:
pg_restore: [archiver (db)] Error from TOC entry 7468; 0 23690 MATERIALIZED VIEW DATA vw_network_segment postgres
pg_restore: [archiver (db)] could not execute query: ERROR:  function st_curvetoline(public.geometry, integer) does not exist
LINE 1: SELECT ST_CurveToLine($1, 32)
               ^
HINT:  No function matches the given name and argument types. You might need to add explicit type casts.
QUERY:  SELECT ST_CurveToLine($1, 32)
CONTEXT:  SQL function "st_curvetoline" during inlining
    Command was: REFRESH MATERIALIZED VIEW vw_network_segment;

I suppose that this is a pg_restore error replacing $1 variable by 'public.geometry' when it should be 'geometry'

QGEP import / manhole view for QField

I was ask questions about the qgep import module and realized there is a lack of documentation about it :

  • qgep_import documentation (I'll take care of it)
  • qgep mobile demo project : would that be necessary since most of the users might create their own mobile project ?

Quick reminder of how it works:

  • The view qgep_import.vw_manhole is used on the field to collect the data
  • Back at the office, when synchronising back the data:
    1. when a manual interaction isn't necessary, the information is automatically udpated
    2. when a manual interaction is necessary, the information is hold in qgep_import.manhole_quarantine

Here is the discussion about the implementation :
QGEP/datamodel#74

Doc update process to transifex?

@m-kuhn Can you tell what's the cycle (automatic, pseudo-automatic or manual) of doc releases to transifex?

I would like to extend a bit the Readme so that contributors know when their contributrions can be translated.

It seems that on https://github.com/qwat/docs an pseudo-automatic release of the doc to transifex (done every time a release is published) but with with no certainty.

Document how to enable / disable history

A small section on how to enable / disable history on QGEP :

Example auditing tables :

SELECT qgep_sys.audit_view('qgep_od.vw_qgep_wastewater_structure', 'true'::boolean, '{}'::text[], '{obj_id}'::text[]);
SELECT qgep_sys.audit_view('qgep_od.vw_qgep_reach', 'true'::boolean, '{}'::text[], '{obj_id}'::text[]);
SELECT qgep_sys.audit_view('qgep_od.vw_cover', 'true'::boolean, '{}'::text[], '{obj_id}'::text[]);
SELECT qgep_sys.audit_view('qgep_od.vw_wastewater_node', 'true'::boolean, '{}'::text[], '{obj_id}'::text[]);

Example stop auditing tables :

qgep_sys.unaudit_table(target_table regclass)
qgep_sys.unaudit_view(target_table regclass)

Translation not visible

I have translated the chapters 2.8.3 - 2.8.5 (how to: hydraulic modeling) into German same weeks ago, but in the Docu there is the english text. Something does not work!?

Translating the projectfile

The actual projectfile has many untranslated values (e.g. in the hydraulic - vw-tables > field alias).
I think for the first version of the translation @m-kuhn did an automatic update with the values in the database. Is that much work? (manual translation is boring...)

There are also the fieldnames of vw_individual_surface missing in transifex.

Proposed improvement: images/screenshots should be in portrait mode

I think that the captured screenshots should have width/length ratio more portrait alike mode because it would improve visualization.

Currently, the images in the generated pdf are hard to visualize unless you zoom in. If someone wants to print to print the pdf it wouldn't discern much out of the full screen screenshots.

Although this means more work as it's far easier to just make a print screen I think it's worth it.

I will try and rework all the Screenshots when I have more time but I wanted your opinion on this first.

@sjib As this issue mainly touches your work (thanks a lot for doing it) it would be nice if you could share your opinion on it.

What do you guys think?

Documentation hydraulic elements in QGEP (weirs, pumps, bassins)

Make documentation about hydraulic elements in QGEP - see for discussion and draft QGEP/QGEP#579

qgep_hydr_geometry

fix qgep group or user missinterpretation

Hi,
Looking at the http://qgep.github.io/docs/installation-guide/system/database-initialization.html I don't quite figure if the user is supposed to create a postgres user or group.

This is because in the privileges part there's talk about a group but we have created a user according to the documentation.

Also, for the Windows/Linux pgadmins that I tested, users don't won't show up in the Pgadmin privileges dialog, only groups.

As a solution, I can update the documentation by creating a qgepgroup group.
Have you got other suggestions?

Procedure to install a specific release is not documented

Hi,
the VM is not working on my machine, and faced issues (next tickets) with sample database or master plugin version. I didn't find a procedure documented to install a specific release from github repositories.
Did I miss it?

Document symbology functions

As discussed with @m-kuhn

Part of the documentation should contain some quick example of the use of symbology fonctions (mainly for database migration and maintenance purposes)

Specifics :

  • Activate / Deactivate symbology triggers
    SELECT qgep_sys.create_symbology_triggers()
    SELECT qgep_sys.drop_symbology_triggers()

  • Run symbology function for all entites.
    SELECT qgep_od.update_wastewater_structure_symbology(NULL,true)

  • Run label function for all entities
    SELECT qgep_od.update_wastewater_structure_label(NULL, true)

  • Run depth calculation for all entities
    SELECT qgep_od.update_depth(NULL, true);

How to translate labels

As QGEP/QGEP#524 raises many questions, I see we did not document how the labels are meant to be translated :

Modifications of the project file are available here but to be synthetic we should document :

  • that labels are now generated separately on the db side in 4 different attributes
  • How to translate a label
    replace(_output_label,'O',@qgep_output_prefix) with @qgep_output_prefix being a layer variable :
    image
    what means users have to go to project settings and change these variables (create these if they were using an existing project )

Documentation new features

Add e.g. here.
https://qgep.github.io/docs/user-guide/digitizing/digitizingwastewaterstructures.html#further-attributes-and-classes

PDF issues

  • it's not possible to produce a PDF of the documentation (error 404) QGEP/QGEP#239
  • images outside chapter: If there are many images in a chapter, sometime they are on the next page in the next chapter. E.g. Chapter 1.1.3 Setup workstation - first two images belong to 1.1.2. QGEP/QGEP#201
  • Content list in QGEP.pdf is only 2 levels deep - can this be adapted to 3 or even 4 levels? QGEP/QGEP#200

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.