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: rename quickstart to launch #724

Conversation

Carlos-Muniz
Copy link

@Carlos-Muniz Carlos-Muniz commented Sep 20, 2022

These changes renames all mentions of quickstart to launch
found in the code and documentation.

Acceptance Criteria:

  • Rename quickstart command to launch.
  • Update Tutor documentation.
  • Search for quickstart across the overhangio GH organization. If quickstart is referenced in any other Tutor repos, update them.
  • Temporarily alias quickstart to launch for backwards-compatibility. Mark quickstart as deprecated and warn users that launch should be used instead.
  • Create a new issue to remove quickstart in a following release (Palm, perhaps?) feat: remove quickstart in Palm (or later) release openedx-unsupported/wg-developer-experience#119
  • Announce the change in the forums and Slack.

This PR is related to the following PRs:

Closes openedx-unsupported/wg-developer-experience#53

@Carlos-Muniz
Copy link
Author

Carlos-Muniz commented Sep 20, 2022

@regisb This and associated PRs are ready for review.
There is one minor thing that I have not added:

  • replace the tutor local quickstart gifs with new tutor local launch gifs

Copy link
Contributor

@regisb regisb left a comment

Choose a reason for hiding this comment

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

Thrilled to see this!

`quickstart` is being renamed to `launch` and deprecated in favor of
using `launch`. The `quickstart` function temporarily aliases to
`launch`. Further mentions of `quickstart` have been changed to
reference `launch` instead.

docs: replace quickstart mentions with launch

Most mentions of quickstart have been renamed to reference launch, as
part of the renaming task. `quickstart.rst` has been renamed to
`launch.rst` in order to maintain consistency.

TODO: create new gifs for `tutor <mode> launch` to replace the ones that
use `tutor <mode> quickstart`.

fix: correct indenting of quickstart functions

docs: add to nightly changelog

fix: correct the formatting to pas test-format

docs: update quickstart installation as launch

docs: un-rename launch back to quickstart

Launch was renamed to quickstart, but that may be confusing. It has been
un-renamed back to quickstart.

fix: call the launch click command the right way

Calls the launch click command via context.invoke(launch, *args,
**kwargs). See https://click.palletsprojects.com/en/7.x/api/#click.Context.invoke

docs: add 💥 to CHANGELOG-nightly.md entry

We are indicating that this change is breaking 💥 to encourage people to
migrate their scripts right away!
@Carlos-Muniz Carlos-Muniz force-pushed the Carlos-Muniz/rename-quickstart-to-launch branch from ee96c27 to e98a00b Compare September 29, 2022 14:37
@Carlos-Muniz Carlos-Muniz requested a review from regisb September 29, 2022 14:37
@regisb regisb merged commit 961a2d8 into overhangio:nightly Sep 30, 2022
@Carlos-Muniz Carlos-Muniz deleted the Carlos-Muniz/rename-quickstart-to-launch branch September 30, 2022 13:17
@regisb
Copy link
Contributor

regisb commented Dec 6, 2022

@Carlos-Muniz FYI the new tutor local launch gif will be pushed as part of the olive upgrade: #734

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