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

Change the 'random' package reference in the GitHub release notes #198

Closed
9 tasks done
stijnmoreels opened this issue Mar 22, 2022 · 2 comments
Closed
9 tasks done
Assignees
Labels
documentation All issues related to documentation enhancement New feature or request management All issues that the Arcus management team should take up.

Comments

@stijnmoreels
Copy link
Member

stijnmoreels commented Mar 22, 2022

Is your feature request related to a problem? Please describe.
When having a single package or an .All package one can easily refer to this one in the GitHub release notes but if that isn't the case we can't just choose a 'random' package.

Describe the solution you'd like
Either list all the available packages in the GitHub release notes, or work with a general description as in:
Install a new version of the Arcus.Security package that you want via NuGet or

PM > Install-Package Arcus.Security.*

With a link to the search results of these packages.

  • Messaging
  • EventGrid
  • Security
  • Web API
  • Background Jobs
  • Templates
  • Testing
  • Observability
  • Scripting

Additional context
First mentioned here: arcus-azure/arcus.security#339 (comment)

@stijnmoreels stijnmoreels added enhancement New feature or request documentation All issues related to documentation management All issues that the Arcus management team should take up. labels Mar 22, 2022
@fgheysels
Copy link
Member

fgheysels commented Mar 24, 2022

Or can we link to our documentation from there ? If we mention all the packages in the release notes, this might become bloated + it becomes yet another part that must be updated when we create a new package.

I would suggest to change this in the release notes to some generic description like:

Install the Arcus.Security package that you need via NuGet, for instance:

Install-Package Arcus.Security.AzureKeyVault

For a complete list of all Arcus.Security packages see the documentation(link to doc)

@stijnmoreels
Copy link
Member Author

Ah, yes, that is also an option. It would indeed not be very maintainable to list everything here. We can definitely add an link to the docs as well 👍 .

stijnmoreels added a commit to arcus-azure/arcus.observability that referenced this issue Apr 13, 2022
Update the release notes header with NuGet installation example.

Relates to arcus-azure/arcus#198
fgheysels pushed a commit to arcus-azure/arcus.observability that referenced this issue Apr 22, 2022
* chore: update release notes header with example

Update the release notes header with NuGet installation example.

Relates to arcus-azure/arcus#198

* Update nuget-release.yml

* Update nuget-release.yml
@stijnmoreels stijnmoreels self-assigned this Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation All issues related to documentation enhancement New feature or request management All issues that the Arcus management team should take up.
Projects
None yet
Development

No branches or pull requests

2 participants