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

Docs: Add additional install methods to quickstart #7362

Merged
merged 3 commits into from
Jun 5, 2024

Conversation

raddevon
Copy link
Contributor

Since the edgedb.com/install page is no longer linked prominently on the site, we should move the alternative method instructions that were there to this page, remove that page, and redirect it here.

Since the edgedb.com/install page is no longer linked prominently on the
site, we should move the alternative method instructions that were there
to this page, remove that page, and redirect it here.
@raddevon raddevon requested a review from beerose May 17, 2024 18:24
Copy link
Member

@beerose beerose left a comment

Choose a reason for hiding this comment

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

Are we going to remove the /install page? If so, we can add a redirect to the docs/intro/quickstart page.

@raddevon
Copy link
Contributor Author

raddevon commented May 20, 2024

Are we going to remove the /install page? If so, we can add a redirect to the docs/intro/quickstart page.

Yes, that's what I was thinking. I can merge this first, followed by a PR on edgedb.com to remove the old page and add a redirect.

@raddevon raddevon requested a review from beerose May 20, 2024 19:50
@raddevon
Copy link
Contributor Author

@beerose I created a PR to remove the /install page and redirect that page's URL to the installation section of the quickstart. Ideally, this should be merged before that one.

@raddevon raddevon requested a review from scotttrinh May 22, 2024 16:17
Copy link
Contributor

@scotttrinh scotttrinh left a comment

Choose a reason for hiding this comment

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

Ack! I've had this comment "pending" for two weeks, sorry! No blockers here, just a question about alt-PMs

Comment on lines 23 to 26
Skip installing and start using the EdgeDB CLI right away! Just use ``npx
edgedb``. For example, to create a new project, you can use ``npx edgedb
project init``. Try it with :ref:`any of our CLI commands
<ref_cli_overview>`!
Copy link
Contributor

Choose a reason for hiding this comment

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

I hate that we have this situation, but I wonder if we need to mention how to invoke it from other package managers or just assume everyone either is fine with using npx, or knows how to do the mental conversion to their own PM syntax (pnpm dlx, yarn dlx, etc).

Not a big deal, but thought it was worth mentioning.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could address it here the way I did in the video: "… npx edgedb or your package manager's equivalent." That doesn't tell anyone how to do it with another package manager, but it at least tells them it can be done in case they weren't aware.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've revised it to incorporate that for now, and we can do something more robust later if we want.

@raddevon raddevon changed the title Add additional install methods to quickstart Docs: Add additional install methods to quickstart Jun 5, 2024
@raddevon raddevon merged commit 8f8c5c7 into master Jun 5, 2024
25 checks passed
@raddevon raddevon deleted the docs-detailed-install-instructions branch June 5, 2024 17:29
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.

None yet

3 participants