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

cloud account refinement initial draft #284

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eedugon
Copy link

@eedugon eedugon commented Feb 3, 2025

Cloud Account content reviewed and organized.
Overview added.

A few concerns (cc: @shainaraskas ):

  • In theory cloud account wasn't going to appear in the navigation menu. Should I update that also now?

  • Would it make sense to put all the content of join-and-leave-an-organization.md directly at index.md instead of having it in a separate doc?

  • Links: should we use relative paths starting with ../../.. or is it ok to use absolute links starting with /deploy-and-manage for example?

  • Important question: I have updated the raw-migrated-files that are being shared with other sections so the owners of the other sections are aware of the information that has been already used in the raw-migrated file. Does that make sense or is it better if we don't touch them? I can discard those changes without issue, please review :)

Closes https://github.com/elastic/docs-projects/issues/291
Closes https://github.com/elastic/docs-projects/issues/304

@shainaraskas
Copy link
Collaborator

In theory cloud account wasn't going to appear in the navigation menu. Should I update that also now?

you're right. I'm not sure how the nav will be built, but long term it won't all be appearing in the left hand side like this - instead, I think a custom top nav will be built and things will manually need to be added to it (rather than having it be auto-generated).

@bmorelli25 is there a good way to keep an eye on this as part of applying the designs you got from UX?

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

probably being too picky because this is the first one. important things to note:

  • add applies to all front matter (including for auto-migrated pages)
  • be careful with "deployments" language because these pages also possibly apply to serverless customers

Copy link
Collaborator

Choose a reason for hiding this comment

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

imo, for the files that you have already used, you should double-check in the IA spreadsheet that they don't need to be used anywhere else, and then if they don't, you can delete them

Copy link
Author

Choose a reason for hiding this comment

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

perfect! I was going to suggest that path too :)

@@ -6,13 +6,24 @@ mapped_urls:

Copy link
Collaborator

Choose a reason for hiding this comment

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

please add applies to the front matter of these pages and the others in the section

https://elastic.github.io/docs-builder/syntax/applies.html

## Edit user account settings [ec-account-user-settings]
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO, we should just make this "user icon > settings" instruction the first step in all of the other pages, and reframe this section as a list of tasks

Comment on lines 7 to +9
# Join or leave an organization

% What needs to be done: Refine
## Accept an invitation [ec-accept-invitation]
Copy link
Collaborator

Choose a reason for hiding this comment

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

you always need a sentence between headings to introduce the scope of a page

## Join an organization from an existing {{ecloud}} account [ec-join-invitation]

You already belong to an organization. If you want to join a new one and bring your deployments over, follow these steps:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I know this copy was from the original, but it's confusing. why does the person already belong to an org?

You already belong to an organization. If you want to join a new one and bring your deployments over, follow these steps:

1. Backup your deployments to any private repository so that you can restore them to your new organization.
Copy link
Collaborator

Choose a reason for hiding this comment

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

do we have a topic we can link to to help them with this?

does this apply to serverless? if so, we need to make it more inclusive because they use projects instead of deployments

Suggested change
1. Backup your deployments to any private repository so that you can restore them to your new organization.
1. Back up your deployments to any private repository so that you can restore them to your new organization.

@shainaraskas
Copy link
Collaborator

Links: should we use relative paths starting with ../../.. or is it ok to use absolute links starting with /deploy-and-manage for example?

you can!

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