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

docs: Use dedicated README file for PackerCLI project #563

Merged
merged 2 commits into from
Sep 24, 2024

Conversation

and-hus
Copy link
Contributor

@and-hus and-hus commented Sep 23, 2024

The repository contains a global README.md file, which nicely introduces the complete SDK and provides some generic information and links. Currently all assets/packages from the repository are configured to use this README.md file when packaging. This means, that this very generic README is also shown e.g. on nuget.org for each package (see e.g. HL7.Cql.Packaging).

I would propose to use dedicated README.md files for each package.
This allows to provide more detailed and more specific documentation and information for the respective package.

As an example, this PR adds a dedicated README.md for the PackagerCli project, which builds into the HL7.Cql.Packaging nuget package. The project configuration is modified to use this dedicated README instead of the global README which is configured via the cql-sdk.props file that is imported at the top of the csproj-file.

When adopting this approach for all projects, we might even remove the inclusion of the global README in the cql-sdk.props file and just go with project specific includes. This would avoid the Remove step.

Copy link
Collaborator

@baseTwo baseTwo left a comment

Choose a reason for hiding this comment

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

We have a ticket for updating the documentation #409 , once continue working on it, I'll also review this PR.

Cql/PackagerCLI/README.md Show resolved Hide resolved
Cql/PackagerCLI/README.md Show resolved Hide resolved
Cql/PackagerCLI/README.md Show resolved Hide resolved
Copy link
Collaborator

@baseTwo baseTwo left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution

@baseTwo baseTwo merged commit cf842e9 into FirelyTeam:develop-2.0 Sep 24, 2024
2 checks passed
@baseTwo baseTwo added the Documentation Improvements or additions to documentation label Sep 24, 2024
@and-hus and-hus deleted the docs/packagerReadme branch September 29, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants