Skip to content

Initial commit of organizations.md document #181

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

Merged
merged 3 commits into from
Mar 28, 2025

Conversation

barstoolbluz
Copy link
Contributor

This is tautological

@floxbot floxbot added the documentation Improvements or additions to documentation label Mar 28, 2025
Copy link

@zmitchell zmitchell changed the base branch from preview to build-preview March 28, 2025 16:23
@zmitchell
Copy link
Member

You need to edit mkdocs.yml to add the page to the sidebar

Copy link
Member

@zmitchell zmitchell left a comment

Choose a reason for hiding this comment

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

Two overarching comments:

  • I don't think you need to make every instance of organization bolded.
  • I don't think each bullet needs a trailing ;.

@@ -0,0 +1,73 @@
# Understanding Organizations in FloxHub

Copy link
Member

Choose a reason for hiding this comment

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

You need a callout saying that this is a paid feature. You can copy the one from concepts/publishing.md


## Managing Organization Properties

The properties of an **organization** (such as membership or access levels) can be updated upon request. Updates _must* be initiated by the organization’s owner. Please contact the Flox team with the desired changes and we will handle the update process.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The properties of an **organization** (such as membership or access levels) can be updated upon request. Updates _must* be initiated by the organization’s owner. Please contact the Flox team with the desired changes and we will handle the update process.
The properties of an **organization** (such as membership or access levels) can be updated upon request. Updates _must_ be initiated by the organization’s owner. Please contact the Flox team with the desired changes and we will handle the update process.


## Managing Organization Properties

The properties of an **organization** (such as membership or access levels) can be updated upon request. Updates _must* be initiated by the organization’s owner. Please contact the Flox team with the desired changes and we will handle the update process.
Copy link
Member

Choose a reason for hiding this comment

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

I would also mention that this is a manual process that will be self-serve in the future.

For each environment, users can:

- See the current generation and a history of changes;
- View a changelog;
Copy link
Member

Choose a reason for hiding this comment

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

This is the same as the previous bullet, right?

Copy link
Member

@brendaneamon brendaneamon Mar 28, 2025

Choose a reason for hiding this comment

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

The current generation tab is really just a more human readable version of the manifest, while the change log tab lets you see the changes over time.

Copy link
Member

Choose a reason for hiding this comment

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

I was referring to "history of changes" and "changelog". Those are the same thing, right?

Copy link

@zmitchell zmitchell merged commit 99aea48 into build-preview Mar 28, 2025
3 checks passed
@zmitchell zmitchell deleted the organization-doc branch March 28, 2025 21:58
Copy link
Member

@brendaneamon brendaneamon left a comment

Choose a reason for hiding this comment

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

Dropped a couple comments after the fact

For each environment, users can:

- See the current generation and a history of changes;
- View a changelog;
Copy link
Member

@brendaneamon brendaneamon Mar 28, 2025

Choose a reason for hiding this comment

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

The current generation tab is really just a more human readable version of the manifest, while the change log tab lets you see the changes over time.


- See the current generation and a history of changes;
- View a changelog;
- Configure basic settings, such as owner and name;
Copy link
Member

Choose a reason for hiding this comment

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

Right now, it's not really possible to do anything but change the name of an environment, delete an environment, or toggle between public and private visibility.

zmitchell added a commit that referenced this pull request Jun 11, 2025
This is tautological

---------

Signed-off-by: barstoolbluz <[email protected]>
Co-authored-by: barstoolbluz <[email protected]>
Co-authored-by: Thomas Bereknyei <[email protected]>
Co-authored-by: Zach Mitchell <[email protected]>
zmitchell added a commit that referenced this pull request Jun 16, 2025
This is tautological

---------

Signed-off-by: barstoolbluz <[email protected]>
Co-authored-by: barstoolbluz <[email protected]>
Co-authored-by: Thomas Bereknyei <[email protected]>
Co-authored-by: Zach Mitchell <[email protected]>
zmitchell added a commit that referenced this pull request Jun 24, 2025
This is tautological

---------

Signed-off-by: barstoolbluz <[email protected]>
Co-authored-by: barstoolbluz <[email protected]>
Co-authored-by: Thomas Bereknyei <[email protected]>
Co-authored-by: Zach Mitchell <[email protected]>
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.

5 participants