eclipse-tractusx / eclipse-tractusx.github.io Goto Github PK

Add this documentation to the project wiki:

https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/wiki

Currently the Business Partner Kit is created as a react Page, this content should be displayed as a document page, the link structure should follow the next one:

• .docs/kits/BusinessPartnerKit:
  • /adoption-view.md
  • /software-operation-view.md
  • /documentation.md
  • /software-development-view/
    • specific.md
    • ...Generated documentation for end-points

2 plugins should be installed:

• https://github.com/rdilweb/docusaurus-plugin-remote-content to bring remote documentation.
• https://github.com/PaloAltoNetworks/docusaurus-openapi-docs to generate Documentation from .yaml files

As discussed in the review of #182, the API documentation of the KITs is generated via the docusaurus gen-api-docs plugin (see this GitHub repository). To prevent misunderstandings, as suggested by @Siegfriedk, a comment should be added to every auto-generated file indicating that it isn't written manually by a human.

One example of such a comment could be:

<!-- ----------------------------------------------------------------------------------------------
    WARNING: THIS FILE IS AUTO-GENERATED!
    Don't edit this page manually. Use docusaurus gen-api-docs to generate it.
----------------------------------------------------------------------------------------------- -->

We would like to add the versioning function provided by Docusaurus to relevant docs or pages.

• Version dropdown in the header navigation
• Version pill / information above the doc / page content

There is a new version of Docusaurus available, that we want to use (see #128).
There is also a PR already opened by @FaGru3n #129
Unfortunately the static build of the website fails with the new Docusaurus version.

Failing build can be seen here. We could also confirm the error locally.
To reproduce, you can upgrade docusaurus locally by running npm i --save @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latest

Currently, it is unknown, what causes these errors, but one guess is, that it might be caused by spaces in the file path.

@santiagoejm could you maybe help us out and analyze, if it is actually caused by spaces in file paths?

How to create an open API documentation in the software development view.

Add this documentation to the project wiki:

https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/wiki

@santiagoejm please change the about teaser image to the .gif file I provided directly because its too large to upload it here. Maybe we need to discuss how to reduce the size without loss of quality. If this is not possible - take this image:

Data Chain Operations View >2 Pictures

Business Partner - Operations View

Please rename the following navigation items:

• "Software Development View" to "Development View"
• "Software Operation View" to "Operation View"

Since different persons with different operating systems are working on this project, defining best practices on line endings would be great. Should we use configurations like autocrlf? Such options can be defined in a .gitattributes file that isn't present right now. More information can be found in the GitHub documentation or in current public discussions.

On the tile of the connector kit is a mistake in writing.
Here is the new, corrected tile.
Please change it on the home page and on the kits page.

The button at the FAQ component looks different to the other buttons - please adapt the design and look.

Checked with Safari and Chrome:

The website footer has to follow a very specific structure.
See Eclipse Handbook
You can see that structure on eclipse.org

/cc @AngelikaWittek

We should provide some documentation, guidelines and good practices for the Eclipse Tractus-X community and everyone thinking about joining.
This section should contain:

• links to important documents for Eclipse Foundation Projects.
• Guidelines on how to join the community
• Checklists for Contribution reviews
• ...

Hi together,
found out that our version for docusaurus can be updated.

see release information on:
https://github.com/facebook/docusaurus/releases/tag/v2.3.1

https://eclipse-tractusx.github.io/docs/kits

The AUTHORS.md example file referenced in release guideline TRG2.03 link is broken. It points to a .md file, but the file itself is present as .txt

The components defined in the project should include each the proper copyright header according to the organisation requirements; please review link and defined which header satisfy the organisation requirements better to the project

When apply, all of the end points generated with the plugin should display in the sidebar navigation the Method (GET, PUT, POST...) that they point to. like the example:

On this page https://eclipse-tractusx.github.io/developer - we still have two items with Lorem Ipsum text.
Please change the images:

The Manrope Font-family should include the proper license before it can be use, according to the organisation and the self font requirements. This criteria should be defined with the legal advisory department or similar.

When working on documentation like the KITs, it is sometimes necessary to add explanation videos or tutorials as described in the Tutorials section of the KIT Artefacts.

By default, GitHub can only handle files up to 100.00 MB. Every bigger one falls under large files.

What is the desired workflow to include large files, like videos?

We want to showcase all of the Eclipse Tractus-X products on the website.
The initial idea is inspired by the product overview of the Eclipse IoT working group: https://iot.eclipse.org/projects/
Solution could be a React component taking a json containing all of the products and rendering it as tiles.
The informations we want to display are:

• Product name
• Product description
• Leading GitHub repository
• Set of committers working on that product (GitHub handles)
• contact link (mailto link to the tractus-x-dev mailing list with pre-filled subject)
• Latest release on GitHub (automatically queried from the leading GitHub repository, not shown if cannot be queried)

The json format could look like this for example:

[
    {
        "product-name": "abc",
        "product-description": "bla bla",
        "github-repo":  "leading-product-repo-link",
        "Committers": [
            "@githubhandle",
            "@anothergithubhandle,"
        ],
        "mailto": "mailto:dev-mailing?subject=abc"
    }
]

The endpoints generated with the plugin currently are located in the next folder:

• .docs/kits/BusinessPartnerKit/software-development-view/...Generated documentation for end-points

They should be generated in the next folder location:

• .docs/kits/BusinessPartnerKit/software-development-view/Pool API/...Generated documentation for end-points

Hi everyone,

I tried following this documentation:
https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/17e95639b5c176d0afc97f0c7d9c899edc15f03a/docs/kits/Data%20Chain%20Kit/page_software-operation-view.md

However, I'm stuck at step 3 as I can't find the described path in the IRS repo.

Thanks!

The Font-family Manrope is been missed in some components across the website, like navigation bar, buttons and .md files, must be corrected

Following things should be changed in the first step:

• more distance between the navigation items
• more space to top-padding and bottom-padding to the navigation items
• more space between logo and the left end of the page

Yellow marked texts need to be changed to the following:
Identifier and the business partner number;
Address Level;
homogeneous

Application and service providers

amount of resources

On the general Docusaurus page they have a search function in the navigation: https://docusaurus.io

Ditto an other project has also a nice search integration: https://websites.eclipseprojects.io/ditto/

A search mechanism should be integrated to find content faster (the number of documentation is growing fast now).

Due to the migration of the content to .docs/kits/ folder, the pages developed as react components for the BusinessPartnerKit and the DataChainKit in the .src/pages are no longer required or in use, along with the components developed for that old UI.

The folders and files that are no longer in use and to be deleted are:

• ./src/pages/BusinessKit
• ./src/pages/DataChainKit
• ./src/components/KitsHeader
• ./static/img/kit_business_logo.svg
• ./static/img/kit_data_chain_logo.svg

Please add the "Useful Links" section with the following items in the footer to the right of the "community" section

• Report a Bug ( https://bugs.eclipse.org/bugs/)
• Documentation (https://help.eclipse.org/latest/index.jsp)
• How to Contribute (https://www.eclipse.org/contribute/)
• Mailing Lists (https://accounts.eclipse.org/mailing-list)
• Forums (https://www.eclipse.org/forums/)

How can we display a site / content on a foldable menu item.

Create main navigation item "Community" and "Versions" next to "Developer Hub".

Text for Community Site:

How can I contribute to Tractus-X?

Anyone can become a contributor or committer to the Eclipse Tractus-X project as part of the Eclipse development process. To build an active open-source community, all ecosystem participants are encouraged to report and fix bugs / patches and implement enhancements according to the Tractus-X timeline and backlog. More coming soon.

Text for Versions Site:

Releases

To realize an active open-source community the Catena-X association will support the coordination of the Eclipse Tractus-X project in 2023, which was initiated by the companies of the Catena-X consortia. In addition, a release roadmap will be published in a reasonable amount of time.

The release roadmap will include a timeline of more than six months to allow end-user and software providers sufficient time to adopt changes. In case of breaking changes, the changes will be announced early enough and an upgrade period will to be coordinated with all affected partners in the future.

Release Cycle
Tractus-X releases are currently planned to happen four times a year depending on the type of service. The release process can be divided in three phases:

• Feature Definition
• Feature Implementation
• Bug Fixing and Stabilization

Versioning
Following the Semantic Versioning terminology, Tractus-X versions are expressed as below:

• MAJOR version (1.Y.Z) when you make incompatible API changes. Participants of the operating environment must implement the latest version immediately to ensure the overall compatibility and functionality of the data space.

• MINOR version (X.1.Z) when you add functionality in a backwards compatible manner. Participants of the operating environment should implement at least one of the recent two minor releases.

• PATCH version (X.Y.1) when you make backwards compatible bug fixes. Participants of the operating environment should implement the latest patch version as soon as possible to ensure security among other things.

The Font-Size of the Home Page, About us page and Developer page is too big, the size of the images take too much space, so a balance of sizes should be defined.

The project name on the landing page of the website has to be 'Eclipse Tractus-X'
-> Include 'Eclipse'
-> Capital 'X'

/cc @AngelikaWittek

Currently, there is only a skeleton menu regarding KITs.
To give the open-source community a brief understanding of what KITs in the Eclipse Tractus-x context mean, we need at least a
TL;DR version of the KIT description

From the README.md:

We do want to follow a specific style for our markdown based documentation. Therefore, this repository is configured to use a markdown linter. Specific rules are configured via .markdownlint.yaml.

The current configuration of .markdownlint.yaml is very aggressive. For example, the MD033/no-inline-html rule doesn't allow HTML tags in such files. This is a problem, for example, when creating complex tables that should create listed items or line breaks. In such a case, adding tags like <br /> in Markdown files is a common practice.

The generation of API documentation with npm run docusaurus gen-api-docs all doesn't work and currently results in the following error:

OpenAPI docs plugin ID must be specified when more than one plugin instance exists.

This is caused by multiple occurrences of the docusaurus-plugin-remote-content, e.g.:
https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docusaurus.config.js#L62
https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docusaurus.config.js#L73

They should be merged into one to solve the problem.

Currently the Data Chain Kit is created as a react Page, this content should be displayed as a document page, the link structure should follow the next one:

• .docs/kits/DataChainKit:
  • /adoption-view.md
  • /software-operation-view.md
  • /documentation.md
  • /software-development-view/
    • specific.md
    • /API endpoint/
      • ...Generated documentation for end-point

1. Footer get 4 columns and be aligned to the edges of the line above
2. Add Eclipse logo to the fourth column
3. Add more space (50px) to the "Copyright .." text

Eclipse logo:

The current Versions page cannot be found. Can you please fix the link / URL.

1.) Please link the following .md file to the main menu item "versions"
https://github.com/eclipse-tractusx/tractus-x-release/blob/main/CHANGELOG.md

2.) Please delete the old .md file afterwads
https://eclipse-tractusx.github.io/versions/

Please add the external resources in the Data Chains Kit under documentation:

• https://eclipse-tractusx.github.io/item-relationship-service/docs/arc42/
• https://raw.githubusercontent.com/eclipse-tractusx/item-relationship-service/gh-pages/docs/administration/