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

Distinguish non-instantiable build items #41909

Conversation

edeandrea
Copy link
Contributor

In the all-builditems docs, use an icon/hover to distinguish non-instantiable build items. These can be extended by other build items, so documenting them is good.

This came from https://quarkusio.zulipchat.com/#narrow/stream/187038-dev/topic/ContainerRuntime-.2C.20PodmanRuntime-.20and.20DockerStatusBuild.2E.2E.2E

cc: @holly-cummins @gastaldi @turing85

Here you can find a list of Build Items and the extension that provides them:
Here you can find a list of Build Items and the extension that provides them.

icon:lock[title=Non-instantiatable Build Item] Build item can't be instantiated directly, but can be extended/inherited from
Copy link
Contributor

Choose a reason for hiding this comment

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

I am unsure if a 🔒 is the best icon to represent this TBH. Maybe use 🏗️ or similar?

Copy link
Contributor

Choose a reason for hiding this comment

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

ChatGPT doesn't help much either:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I went with the lock for a few reasons:

  1. I didn't know of any other one that would work OOTB in asciidoc :)
  2. Locked is kinda like abstract. It's locked, meaning can't be changed.

I can change to whatever

Copy link
Contributor Author

@edeandrea edeandrea Jul 15, 2024

Choose a reason for hiding this comment

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

Similar results with Claude...

image
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we're also constrained to the font-awesome library

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed to a building icon
image

This comment has been minimized.

This comment has been minimized.

@edeandrea edeandrea force-pushed the distinguish-non-instantiable-builditem-in-doc branch from 7ffa66c to f55a493 Compare July 15, 2024 20:50

This comment has been minimized.

This comment has been minimized.

@edeandrea
Copy link
Contributor Author

Do we want to merge this?

Copy link
Contributor

@gastaldi gastaldi left a comment

Choose a reason for hiding this comment

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

I think it's a good addition. Let's merge this

@gastaldi
Copy link
Contributor

@edeandrea can you resolve the conflicts?

@edeandrea
Copy link
Contributor Author

@edeandrea can you resolve the conflicts?

Who messed with my stuff? :D

j/k i'll do that now

@edeandrea
Copy link
Contributor Author

Let me test and then squash now that i've resolved the conflicts

This comment has been minimized.

This comment has been minimized.

@edeandrea edeandrea force-pushed the distinguish-non-instantiable-builditem-in-doc branch from 600cb27 to 0d37b12 Compare July 19, 2024 14:15
In the all-builditems docs, use an icon/hover to distinguish non-instantiable build items. These can be extended by other build items, so documenting them is good.

This comment has been minimized.

@edeandrea edeandrea force-pushed the distinguish-non-instantiable-builditem-in-doc branch from 6466da5 to f9efa74 Compare July 19, 2024 14:33
@edeandrea
Copy link
Contributor Author

Ok formatting fixed. Everything squashed

@gastaldi gastaldi added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jul 19, 2024
Copy link

quarkus-bot bot commented Jul 19, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit f9efa74.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

@gastaldi gastaldi merged commit f84b683 into quarkusio:main Jul 19, 2024
22 checks passed
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jul 19, 2024
@quarkus-bot quarkus-bot bot added this to the 3.14 - main milestone Jul 19, 2024
Copy link

quarkus-bot bot commented Jul 19, 2024

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit f9efa74.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.

Copy link

🙈 The PR is closed and the preview is expired.

@edeandrea edeandrea deleted the distinguish-non-instantiable-builditem-in-doc branch July 19, 2024 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants