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

feat: add docs for how to deploy the filesystem client #17

Merged

Conversation

jedel1043
Copy link
Contributor

No description provided.

@jedel1043 jedel1043 force-pushed the how-to-deploy-shared-filesystem branch 7 times, most recently from 6acd2c1 to 757f924 Compare January 21, 2025 14:53
@jedel1043
Copy link
Contributor Author

I think this is on a good enough state for review.

@jedel1043 jedel1043 marked this pull request as ready for review January 21, 2025 14:56
@jedel1043 jedel1043 requested a review from a team as a code owner January 21, 2025 14:56
@jedel1043 jedel1043 requested review from AshleyCliff and removed request for a team January 21, 2025 14:56
@jedel1043 jedel1043 force-pushed the how-to-deploy-shared-filesystem branch from 757f924 to 7cd70b7 Compare January 21, 2025 14:58
Copy link
Contributor

@AshleyCliff AshleyCliff left a comment

Choose a reason for hiding this comment

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

Overall content looks great! Provided a few grammar changes and some organization suggestions.

Comment on lines 196 to 197
To add the charm that takes care of mounting a shared filesystem to the cluster nodes,
deploy the `filesystem-client` charm:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To add the charm that takes care of mounting a shared filesystem to the cluster nodes,
deploy the `filesystem-client` charm:
To add the `filesystem-client` charm, which mounts a shared filesystem to the cluster nodes:

@jedel1043 jedel1043 force-pushed the how-to-deploy-shared-filesystem branch from 7cd70b7 to 36faade Compare January 27, 2025 21:35
@jedel1043 jedel1043 requested a review from AshleyCliff January 27, 2025 21:58
@jedel1043 jedel1043 force-pushed the how-to-deploy-shared-filesystem branch 2 times, most recently from 6a6a55c to ad4e220 Compare January 27, 2025 22:03
Copy link
Contributor

@AshleyCliff AshleyCliff left a comment

Choose a reason for hiding this comment

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

Looks great! The change away from the second set of tabs helps. One small grammar edit and note on the public cloud links.

Comment on lines 31 to 35
- Amazon Web Services
- See [Create an NFS file share using the default configuration][aws-nfs] for general set up information.
- Azure
- See [Tutorial: Create an NFS Azure file share and mount it on a Linux VM using the Azure portal][azure-nfs]
for general set up information.
Copy link
Contributor

Choose a reason for hiding this comment

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

This could probably be formatted more cleanly but I'm not quite sure what that would look like - I'll think about it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made some adjustments to use clickable cards instead of a bullet list. Let me know if this looks better!

Copy link
Contributor

Choose a reason for hiding this comment

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

I like the cards! I might see if we can tweak the background color so they stand out a bit more (darn dark mode), but they're functional as is.

@jedel1043 jedel1043 force-pushed the how-to-deploy-shared-filesystem branch from ad4e220 to 4cf536d Compare January 29, 2025 17:22
@jedel1043 jedel1043 force-pushed the how-to-deploy-shared-filesystem branch from 4cf536d to c11a41b Compare January 29, 2025 17:25
@AshleyCliff AshleyCliff merged commit 66f2d07 into charmed-hpc:main Jan 29, 2025
2 checks passed
@jedel1043 jedel1043 deleted the how-to-deploy-shared-filesystem branch January 29, 2025 18:00
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.

2 participants