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: mention known users #1887

Merged
merged 1 commit into from
Jun 18, 2024
Merged

docs: mention known users #1887

merged 1 commit into from
Jun 18, 2024

Conversation

tormath1
Copy link
Contributor

Flatcar is using Ignition since the beginning and we are more than happy with it.

--
Let's make it official? And I would like to mention this again: coreos/afterburn#1076 (comment)

as Flatcar is a good user of Ignition / Afterburn maybe we can help in the maintenance/release process of those software

prestist
prestist previously approved these changes Jun 14, 2024
Copy link
Collaborator

@prestist prestist left a comment

Choose a reason for hiding this comment

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

Ah good point! LGTM!

@prestist prestist added the skip-notes This PR does not need release notes label Jun 14, 2024
@prestist
Copy link
Collaborator

Looking into failing ci (its spans the repo atm)

@laenion
Copy link
Contributor

laenion commented Jun 16, 2024

If you want to list more users it would be possible to also add openSUSE MicroOS and SUSE Linux Enterprise Micro to the list :)

@tormath1
Copy link
Contributor Author

If you want to list more users it would be possible to also add openSUSE MicroOS and SUSE Linux Enterprise Micro to the list :)

@prestist @laenion then what about a "Users" section? I think it's hard to read if we have all the OS in the same sentence. Something like:

# Ignition

Ignition is the utility to manipulate disks during the initramfs.[...]

## Users

- Fedora CoreOS
- RHEL CoreOS
- Flatcar
- openSUSE
- MicroOS
- SUSE Linux Enterprise Micro

@laenion
Copy link
Contributor

laenion commented Jun 17, 2024

If you want to list more users it would be possible to also add openSUSE MicroOS and SUSE Linux Enterprise Micro to the list :)

@prestist @laenion then what about a "Users" section? I think it's hard to read if we have all the OS in the same sentence. Something like:

Thanks for doing this - I didn't want to crash your submission, I just wanted to ask whether there was interest in adding more distributions from the maintainers side.

In case there is:

- Fedora CoreOS
- RHEL CoreOS
- Flatcar
- openSUSE
- MicroOS
- SUSE Linux Enterprise Micro

It would be "openSUSE MicroOS" (it's one name).

How about something like:

Ignition is the utility used by several distributions to manipulate disks during the initramfs. This includes partitioning disks, formatting partitions, writing files (regular files, systemd units, etc.), and configuring users. On first boot, Ignition reads its configuration from a source of truth (remote URL, network metadata service, hypervisor bridge, etc.) and applies the configuration.

Known users are:
- Fedora CoreOS
- RHEL CoreOS
- Flatcar
- openSUSE MicroOS
- SUSE Linux Enterprise Micro

Maybe this could also prefixed by

Originally developed for Fedora CoreOS and RHEL CoreOS,

@prestist
Copy link
Collaborator

@tormath1 and @laenion Yeah that sounds good, I dont see why not. If we are to add a user section, maybe we keep the first bit of the readme i.e instead of what we have now just change the first line to something like

Ignition is a utility created to manipulate disks during the initramfs.

Then we can have the users section and maybe call it "known users" wdyt?

Thank you for working on this! great idea :)

@travier
Copy link
Member

travier commented Jun 17, 2024

👍🏻

now just change the first line to something like

s/line/sentence/

RHEL CoreOS

Red Hat Enterprise Linux CoreOS

@prestist prestist dismissed their stale review June 17, 2024 13:55

Scope increase

add Ignition users

Signed-off-by: Mathieu Tortuyaux <mtortuyaux@microsoft.com>
@tormath1 tormath1 changed the title docs: add Flatcar mention docs: mention known users Jun 17, 2024
Copy link
Collaborator

@prestist prestist left a comment

Choose a reason for hiding this comment

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

Thank you for doing this :) LGTM

@prestist prestist merged commit c8dcddb into coreos:main Jun 18, 2024
9 checks passed
@tormath1 tormath1 deleted the tormath1/flatcar branch June 18, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-notes This PR does not need release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants