Git Product home page Git Product logo

Comments (4)

clausnagel avatar clausnagel commented on August 25, 2024 1

For the last releases, we used the version of the Importer/Exporter and not the version of the 3DCityDB as version number for the docs. The rationale was that we much more often publish a new version of the Importer/Exporter than of the 3DCityDB, and each release requires an updated documentation. So, yes, release-4.3 should be available and contains the documentation of the 3DCityDB 4.1 as this version is bundled with the Importer/Exporter 4.3.

The issue is that the documentation covers a "suite" or bundle of separate software components (3DCityDB, Importer/Exporter, WFS, 3D-Web-Map-Client, Importer/Exporter plugins) all having their own version numbers and release cycles. Starting from the next release, we therefore plan to assign a separate version number to this entire bundle based on the year and a counter (e.g., 2021.0, 2021.1, 2022.0, ...). And we will use this version as version of the docs. The start page of the docs will then contain a table listing the version numbers of each component contained in the bundle. And each chapter dedicated to a specific component will also contain the version number of the component.

We hope, this will make it clearer what the docs contain. You can already check this out for the latest docs at: https://3dcitydb-docs.readthedocs.io/en/latest/.

from 3dcitydb-docs.

clausnagel avatar clausnagel commented on August 25, 2024 1

We just released the latest version following the schema described above: https://3dcitydb-docs.readthedocs.io/en/version-2021.1/

So, closing this issue.

from 3dcitydb-docs.

clausnagel avatar clausnagel commented on August 25, 2024

The latest version is automatically created from the master branch and, thus, always contains the most up to date content.

Whenever the development of a new feature for one of the 3DCityDB components (such as database schema, Importer/Exporter, WFS) has been completed, we document the new feature and merge the new documentation into master. This is when latest gets updated automatically. So, latest does not point to the most recent release but rather reflects the next upcoming release. I agree that this is confusing. Maybe edge would be a better version label than latest for this purpose.

I am not sure whether we can change this behaviour (see readthedocs documentation). But it seems that readthedocs offers a stable label to point to the most recent release. We will check how to make this available.

from 3dcitydb-docs.

mulfvik avatar mulfvik commented on August 25, 2024

Ok, thank you, so the version of the docs does not reflect version of 3DCityDB but rather the docs it self? Just to clarify..
Docs release-4.1 is for 3DCityDB v.4.1
Docs latest is for 3DCityDB upcoming release or if pulling directly from repo
Docs release-4.3 should not be available

from 3dcitydb-docs.

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.