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

Rename suites to projects #254

Closed
Tracked by #250
andrewvc opened this issue May 19, 2022 · 6 comments · Fixed by #280
Closed
Tracked by #250

Rename suites to projects #254

andrewvc opened this issue May 19, 2022 · 6 comments · Fixed by #280
Assignees
Labels
bug Something isn't working

Comments

@andrewvc
Copy link
Contributor

andrewvc commented May 19, 2022

AC:

  • Change suites to projects (that's the scope of this issue)

image

Original issue text below

We currently let users export javascript for both inline scripts and projects via the UI shown below. The ability to format for projects is confusing to some users. This issue kicks off a discussion on how we can improve this.

The more I think about it, the more I think we don't need that feature, for script users they can add their own wrapping journey statements, but I want to leave this issue up as a placeholder.

@kyungeunni
Copy link
Contributor

kyungeunni commented Jun 1, 2022

script users they can add their own wrapping journey statements

I agree! Although, if it's the very first time the user creates the synthetics code, it's probably not so obvious how they need to organize the test file(including file name). In this case, we can add a help text or a link to the documentation so users know what to do.

If we decide to keep this feature, however, we should:

  1. remove the term suite and come up with a better term(probably project? but users would need more context what is project).
  2. make it obvious what is the difference between these two options.

@paulb-elastic
Copy link
Contributor

Yeah, I wonder, if we remove this option, will a user just copy the code into their project folder, and wonder why it doesn't work?

I guess the problem here is that even with the current suite (should change this to project) export option, this still won't work if trying to push because there are new mandatory fields needed (such as location).

Maybe we should actually enhance the project export option to include these (even if it sets the location to "set-your-location-here", so there's a placeholder they know they need to edit.

@paulb-elastic
Copy link
Contributor

To focus on MMFS, change suites to projects (that's the scope of this issue)

@shahzad31
Copy link
Contributor

@paulb-elastic should this be pushed to 8.4?

@andrewvc
Copy link
Contributor Author

I agree with @paulb-elastic and have updated the top comment. All we're going to do here is rename suites to projects

@andrewvc andrewvc changed the title Discussion: Cleaner UI for projects? Rename suites to projects Jun 30, 2022
@andrewvc andrewvc added the bug Something isn't working label Jun 30, 2022
@justinkambic
Copy link
Contributor

Checked this against recent main version of recorder, there is no mention of suite in copy or code. Post-FF testing LGTM

@justinkambic justinkambic self-assigned this Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants