op-ted/eforms-docs

eForms SDK documentation

eForms SDK Documentation

Please use the TED Developer Docs portal if you want to read the eForms SDK Documentation.

This Github repository is only used for authoring the SDK documentation and maintaining its different versions.
The eForms SDK Documentation is written in AsciiDoc, following the docs-as-code paradigm.

How this repository is organised

For each version of the eForms SDK, a separate branch is maintained in this repository containing the sources of the documentation of the respective version of SDK. This allows us to retrospectively fix errors in previous versions of the SDK documentation (fixing broken links for example).

Branch names indicate only the major and minor version number of the eForms SDK to the documentation of which their content corresponds. The documentation of the latest revision of each minor version of the SDK is always available to you in the TED Developer Docs portal.

The main branch of this repository is used exclusively for authoring "un-versioned" documents that complement the eForms SDK documentation. Such "version-less" documents are for example the eForms FAQ, the SDK RoadMap, or other similar in nature content.

Workspace Setup

VSCode installation

1. Install "Visual Studio Code" from EC Store.
2. Start "Visual Store Code [V5]" (if it is already running, restart it).

From within VSCode:

1. Configure proxy for VS Code and terminal:

   1. Open "View > Command Palette..." and select "Preferences: Open Settings (JSON)".

   2. Add or edit (if they already exist) the following lines, replacing values between "<" and ">":

      "http.proxy": "http://<username:<password>@<proxy_host>:<proxy_port>",
      "terminal.integrated.env.windows": {
        "http_proxy": "http://<username:<password>@<proxy_host>:<proxy_port>",
        "https_proxy": "http://<username:<password>@<proxy_host>:<proxy_port>"
      }

NOTE: When editing "settings.json", make sure that the resulting JSON is valid by fixing any warnings/errors that might appear.

eforms-docs's Issues

Notice type QS incorrectly listed as PIN instead of CN

In table 1 n this page: https://docs.ted.europa.eu/eforms/latest/schema/schemas.html
QS (Notice subtype 15) is listed as a Prior information notice, while it is a contract notice.

The sdk itself confirms that it is indeeed a CN: https://github.com/OP-TED/eForms-SDK/blob/develop/notice-types/notice-types.json

Playbook points to the wrong repository.

The Antora playbook is actually not needed in this repository. However, if we want to keep it as a reference for people that try to build the eForms docs locally, we should at least fix the content source (url, start_path and branches).

eforms-docs/antora-playbook.yml

Line 7 in 03044a8

- url: https://github.com/OP-TED/eForms-SDK.git

Dokumentation for version 1.0 no longer available on docs.ted.europa.eu/eforms

We develop a software that makes available eForm documents in various version. At the moment we support the stable version 1.0 of eForms. Even if we support newer versions in the future, notices published right now will always be delivered as version 1.0 eForm documents.

For our users we would like to make documentation for all eForms versions that we support permanently available. Ideally we would just refer to https://docs.ted.europa.eu. Unfortunately the documentation for version 1.0 is already gone from this website. Only the following versions are available at the moment:

1.4.0
1.3.2
1.2.1
1.1.1

Could you please republish the documentation for version 1.0 and no longer delete documentation for stable versions?

The release interval of new eForms versions seams rather short at the moment. Would it make sens to declare some versions as "long-term" versions so that external software doesn't need to be modified for new every minor release that is published?