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.

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

Fix Obstacles / Update Main Readme #1651

Open
3 tasks
tjohnson7021 opened this issue Dec 10, 2024 · 0 comments
Open
3 tasks

Fix Obstacles / Update Main Readme #1651

tjohnson7021 opened this issue Dec 10, 2024 · 0 comments
Assignees
Labels
devex/opex A development excellence or operational excellence backlog item. Stream 1 Stream 2

Comments

@tjohnson7021
Copy link
Contributor

tjohnson7021 commented Dec 10, 2024

DevEx/OpEx

The main readme for the CDC Intermediary (TI) has some items that need to be updated and clarified. There are a few sections of the README that could use some additional attention and care.

We will be reviewing the readme with the goal of making it easier to use and providing better direction for our users.

Tasks

  • Review the Readme for clarity and ease of use and record questions, comments and suggestions in this document.
  • Create tasks from the document above.
  • Changes to be made:

Additional Context

  • There is a significant amount of strife for most devs when following setup instructions for these systems and getting them to work together.
  • It could be made more clear from the start that their are two different ways of running the app (Gradle or Container Option).
  • The readme is still a bit out of order when it comes to setup ( Ex:Why does using and running and token generation come before requirements and initial setup?)
  • A document has be created here to track discussion on potential changes https://docs.google.com/document/d/1b5FO_CUpV825Kr-xSQAWUmq-XA7Nj-2NiAKDqmWlI0k/edit?usp=sharing
@tjohnson7021 tjohnson7021 added the devex/opex A development excellence or operational excellence backlog item. label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devex/opex A development excellence or operational excellence backlog item. Stream 1 Stream 2
Projects
None yet
Development

No branches or pull requests

4 participants