Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ 2° ] - Release/v1.0.0-notice-readme: Added base image references in readme and added Install file #89

Merged
merged 21 commits into from
Jul 18, 2023
Merged

[ 2° ] - Release/v1.0.0-notice-readme: Added base image references in readme and added Install file #89

merged 21 commits into from
Jul 18, 2023

Conversation

saudkhan116
Copy link
Contributor

@saudkhan116 saudkhan116 commented Jul 10, 2023 •
edited by matbmoser
Loading

Why we create this PR?

There is a requirement to create an INSTALL.md file TRG 1.02 and the need for base image reference. #82 and #42

What we want to achieve with this PR?

  • Create an INSTALL.md file with instructions needed to install the application
  • Reference this new file in main README.md file of the project
  • Update README.md files with Helm charts information by running helm-docs tool application

What is new?

Added

  • Added documentation with instructions needed to install the application
  • Added base image information to main readme
  • Install.md file included in the repository.

Updated

  • Updated readme documentation of the digital product pass components.

dsrparracho and others added 18 commits July 3, 2023 14:54
@dsrparracho
feature/cmp-732/create-installmd-file: created install.md file and up…
77317f2 
…dated Readme files by running helm-docs application
@saudkhan116
feat: add notice for docker images in a root README.md
85a9d60
@dsrparracho
feat: minor changes in INSTALL.md file related to titles names
42e83f6
@matbmoser
Merge pull request #112 from catenax-ng/main
1a79c35 
Merge main into develop
@matbmoser
Merge pull request #113 from catenax-ng/main
376e5ab 
Update develop
@saudkhan116
Merge branch 'eclipse-tractusx:main' into feature/cmp-703/add-docker-…
42db0f5 
…images-notice
@saudkhan116
add resource utilization in a dpp helm chart
eebd1b8
@dsrparracho
feat: added the base images used in the project in the main README.md…
5bb4a46 
… file
@dsrparracho
feat: added links to DEPENDENCIES files in NOTICE and Helm and App ve…
ca44496 
…rsion in READEME file to be compliant with Quality Checks
@saudkhan116
Merge pull request #114 from catenax-ng/feature/cmp-703/add-docker-im…
9ca93f3 
…ages-notice

feature/cmp 703/add-docker-images-notice: added notes for docker images in a root README.md
@saudkhan116
Merge pull request #115 from catenax-ng/feature/cmp-704/add-resource-…
f77331b 
…utilization-in-helm-charts

feature/cmp-704/add-resource-utilization: add default CPU and memory settings in helm
@matbmoser
Merge branch 'develop' into feature/cmp-732/create-installmd-file
6ca3c2f
@matbmoser
chore: updated readme app and helm versions
ed049c2
@matbmoser
Merge branch 'develop' into feature/cmp-705/revise-legal-docs
d86bd2e
@matbmoser
Merge pull request #120 from catenax-ng/feature/cmp-705/revise-legal-…
2a5da02 
…docs

Feature/cmp 705/revise legal docs: remerge
@matbmoser
Merge pull request #123 from catenax-ng/feature/cmp-710/add-base-images
1fc5c3c 
feat: added the base images used in the project in the main README.md…
@dsrparracho
feature/cmp-732/create-installmd-file: ran helm-docs again to generat…
56aaecd 
…e readme files with last updated charts
@saudkhan116
Merge branch 'eclipse-tractusx:main' into release/v1.0.0-notice-readme
3cba70a
@saudkhan116 saudkhan116 requested a review from matbmoser July 10, 2023 11:47
@saudkhan116 saudkhan116 changed the title [ 2° ] - Release/v1.0.0-notice-readme: prepare INSTALL.md and update existing dpp documentation [ 2° ] - Release/v1.0.0-notice-readme: prepare INSTALL.md and update existing dpp readme.md Jul 10, 2023
@saudkhan116 saudkhan116 added the documentation Improvements or additions to documentation label Jul 10, 2023
@saudkhan116 saudkhan116 added this to the v1.0.0 milestone Jul 10, 2023
@matbmoser matbmoser mentioned this pull request Jul 18, 2023
Closed
@matbmoser matbmoser changed the title [ 2° ] - Release/v1.0.0-notice-readme: prepare INSTALL.md and update existing dpp readme.md [ 2° ] - Release/v1.0.0-notice-readme: Added base image references in readme Jul 18, 2023
@matbmoser matbmoser changed the title [ 2° ] - Release/v1.0.0-notice-readme: Added base image references in readme [ 2° ] - Release/v1.0.0-notice-readme: Added base image references in readme and added Install file Jul 18, 2023
@matbmoser
Merge pull request #135 from catenax-ng/feature/cmp-732/create-instal…
4099035 
…lmd-file

Feature/cmp 732/create installmd file: created INSTALL.md file
@matbmoser matbmoser merged commit 37ee999 into eclipse-tractusx:main Jul 18, 2023
@matbmoser matbmoser deleted the release/v1.0.0-notice-readme branch July 18, 2023 08:54
@matbmoser matbmoser mentioned this pull request Jul 18, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matbmoser matbmoser matbmoser approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@saudkhan116 @matbmoser @dsrparracho