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

Documentation additions for next 7.1 #146

Merged
merged 7 commits into from
Mar 18, 2024

Conversation

chrisrueger
Copy link
Contributor

@chrisrueger chrisrueger commented Dec 12, 2023

This PR intends to add new documentation relevant website content for the next release e.g.

Java OSGi Service Wizard

  • added a new "Project Templates" Sidebar entry
image image

@scottslewis
Copy link

Hi @chrisrueger

Although I hightly appreciate your effort here, I would recommend leaving out the 'Custom OSGi Service Wizards' section if the release of bndtools is imminent (within next month say). The example I provided and that you put in is really minimal and doesn't really provide enough information on how to use the new wizard extension point (along with the associated bndtools template),

I just provided it to explain to you and other bndtools developers what was now possible. I will commit to producing more detailed documentation with full examples (maybe a tutorial) about this for a future release, but I feel that the amount of docs available right now for the Custom OSGi Service wizard extensions is less helpful that it should/must be/currently for other bndtools devs to actually use.

@chrisrueger
Copy link
Contributor Author

@scottslewis you mean leaving out this commit for there Developer Guide?

Sure no problem. I will revert it.

This reverts commit 25632e3.
Signed-off-by: Christoph Rueger <[email protected]>
@scottslewis
Copy link

@scottslewis you mean leaving out this commit for there Developer Guide?

Yeah. I promise to produce a full explanation of the use of the new wizard extension point with the bndtools service templating capability, but I can't right away.

Sure no problem. I will revert it.

Thanks.

Signed-off-by: Christoph Rueger <[email protected]>
this allows us to display a little badge on the top of the page telling which bndtools version the current page assumes. this badge links to the respective changelog page in github e.g.  since: 7.1.0 links to https://github.com/bndtools/bnd/wiki/Changes-in-7.1.0

also updated the resolution-view.png to show the new features / buttons

and also  moved some images to the existing images folder

Signed-off-by: Christoph Rueger <[email protected]>
@chrisrueger chrisrueger marked this pull request as ready for review March 15, 2024 20:08
@chrisrueger
Copy link
Contributor Author

@pkriens I think I am ready.
I added the "since: 7.1.0" variable to markdown header and show it at the top of the page (What we discussed in the call today)

image

I think this one can be merged.

@pkriens pkriens merged commit 4daee1f into bndtools:master Mar 18, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants