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

feature/cmp-732/create-installmd-file: created install.md file and up… #110

Merged
merged 6 commits into from
Jul 18, 2023
Merged

feature/cmp-732/create-installmd-file: created install.md file and up… #110

merged 6 commits into from
Jul 18, 2023

Conversation

dsrparracho
Copy link

Why we create this PR?

There is a requirement to create an INSTALL.md file TRG 1.02

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?

New Files

    new file:   INSTALL.md
    new file:   deployment/helm/edc-consumer/README.md
    new file:   deployment/helm/edc-provider/README.md

Updated

    modified:   README.md
    modified:   charts/digital-product-pass/README.md
    modified:   consumer-backend/productpass/readme.md
    modified:   deployment/helm/edc-provider/data-service/README.md

PR Linked to:

Tickets
cmp-732

@dsrparracho
feature/cmp-732/create-installmd-file: created install.md file and up…
77317f2 
…dated Readme files by running helm-docs application
@dsrparracho dsrparracho added the documentation Improvements or additions to documentation label Jul 3, 2023
@dsrparracho dsrparracho requested a review from matbmoser July 3, 2023 14:05
@matbmoser matbmoser force-pushed the develop branch 2 times, most recently from cebfaa6 to 1d99a11 Compare July 4, 2023 13:53
@matbmoser matbmoser deleted the branch develop July 4, 2023 13:54
@matbmoser matbmoser closed this Jul 4, 2023
@matbmoser matbmoser reopened this Jul 4, 2023
@matbmoser matbmoser added the action needed The PR or issues is not yet ready to close. label Jul 7, 2023
@matbmoser
Copy link

We need to run again the helm docs

@matbmoser matbmoser deleted the branch develop July 7, 2023 10:34
@matbmoser matbmoser closed this Jul 7, 2023
@matbmoser matbmoser reopened this Jul 7, 2023
@matbmoser
Copy link

We need to change the secret configuration in the install md

@dsrparracho
feature/cmp-732/create-installmd-file: updated config secrets structu…
760b5a6 
…re on INSTAL.md file and added AUTHORS.md file
matbmoser
matbmoser suggested changes Jul 14, 2023
View reviewed changes
deployment/helm/edc-consumer/README.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add the Header License

deployment/helm/edc-provider/README.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here also

deployment/helm/edc-provider/data-service/README.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here also

consumer-backend/productpass/readme.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here also

charts/digital-product-pass/README.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here also if there is not

@matbmoser matbmoser removed the action needed The PR or issues is not yet ready to close. label Jul 18, 2023
@matbmoser matbmoser self-requested a review July 18, 2023 08:10
@dsrparracho dsrparracho merged commit 434c343 into develop Jul 18, 2023
@dsrparracho dsrparracho deleted the feature/cmp-732/create-installmd-file branch July 18, 2023 08:10
@matbmoser matbmoser restored the feature/cmp-732/create-installmd-file branch July 18, 2023 08:22
@matbmoser matbmoser deleted the feature/cmp-732/create-installmd-file branch July 18, 2023 08:53
@dsrparracho dsrparracho restored the feature/cmp-732/create-installmd-file branch July 19, 2023 06:28
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
No milestone
Development

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