docs: align portal iam doc structure with trg 1

[shahmargi12]

Description

• Restructured existing documents according to the new TRG 1 folder hierarchy.
• Created a new README.md with links to the relevant files and subfolders, ensuring all documents are properly referenced and accessible.

Structure that followed in PR -

repository
└─── docs/
    └─── admin/
         └─── technical-documentation/
         └─── dev-process/
         └─── release-process/
         └─── known-knowns/
    └─── consultation/
         └─── portal-iam-helm.chart.md
         └─── charts/
         └─── environment/
         └─── workshops/
         └─── consultation.md
    └─── README.md

Why

To align with TRG 1

Issue

#187

Checklist

Please delete options that are not relevant.

• I have followed the contributing guidelines
• I have added copyright and license headers, footers (for .md files) or files (for images)
• I have performed a self-review of my changes
• I have successfully tested my changes

[shahmargi12]

Hello @evegufy @MaximilianHauer

I noticed that the quality gate is failing due to some issues in the YAML files. The only change I made related to these files is moving their folder location, without modifying the content itself.

Could you please take a look and help me resolve the issue? It seems like the errors might be triggered by the folder restructuring.

[evegufy]

Hello @evegufy @MaximilianHauer

I noticed that the quality gate is failing due to some issues in the YAML files. The only change I made related to these files is moving their folder location, without modifying the content itself.

Could you please take a look and help me resolve the issue? It seems like the errors might be triggered by the folder restructuring.

@shahmargi12 thank you for the contribution!
Regarding sonarcloud: could you please add such a file https://github.com/eclipse-tractusx/portal-frontend/blob/main/.sonarcloud.properties where you exclude the docs directory? https://stackoverflow.com/questions/21323276/sonarqube-exclude-a-directory Thank you!

[shahmargi12]

@evegufy I’ve updated the .sonarcloud.properties file to exclude the docs directory. You can find the details in this PR: #1275.
Thank you!

[shahmargi12]

Hello @evegufy
Apologies for the earlier confusion. I’ve updated the sonarcloud.properties file to ignore the .yaml file inside the docs folder.

Let me know if you need any further adjustments.

[evegufy]

Hello @evegufy Apologies for the earlier confusion. I’ve updated the sonarcloud.properties file to ignore the .yaml file inside the docs folder.

Let me know if you need any further adjustments.

@shahmargi12 perfect, thank you! sorry, I didn't remember that there is already a sonarcloud.properties and the existing one could to be updated.

[evegufy]

I had a look and as architecture and user documentation doesn't exist in this repo, I think it makes sense to restructure like this:

repository
└─── docs/
    └─── admin/
         └─── technical-documentation/
         └─── known-knowns/
         └─── dev-process/
         └─── release-process/
    └─── consultation/
         └─── portal-iam-helm.chart.md
         └─── charts/
         └─── environment/
         └─── workshops/
         └─── consultation.md
    └─── README.md

[shahmargi12]

I had a look and as architecture and user documentation doesn't exist in this repo, I think it makes sense to restructure like this:

repository
└─── docs/
    └─── admin/
         └─── technical-documentation/
         └─── known-knowns/
         └─── dev-process/
         └─── release-process/
    └─── consultation/
         └─── portal-iam-helm.chart.md
         └─── charts/
         └─── environment/
         └─── workshops/
         └─── consultation.md
    └─── README.md

@evegufy Thanks for the suggestion! I’ve restructured the documentation according to your recommendations.

[evegufy]

looks really good, thank you @shahmargi12

[evegufy]

sorry I noticed that there's still a change needed

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[shahmargi12]

sorry I noticed that there's still a change needed

@evegufy I’ve made the change as requested. Let me know if there's anything else that needs updating.