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

Unified quickstart that uses Enterprise features #937

Open
wants to merge 37 commits into
base: main
Choose a base branch
from
Open

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Dec 20, 2024

Description

Review deadline: 17 January

Fixes https://github.com/redpanda-data/documentation-private/issues/2545
Fixes https://github.com/redpanda-data/documentation-private/issues/2672

TODO:

  • Create redirects from previous attachments location (get-started and console to the new location in labs)

Test locally

You need Docker.

Note to reviewers: The quickstart includes a single command to download the required files at https://docs.redpanda.com/redpanda-quickstart. The command won't work yet. For now, use this for testing:

mkdir redpanda-quickstart && cd redpanda-quickstart && \
curl -sSL https://deploy-preview-937--redpanda-docs-preview.netlify.app/redpanda-quickstart.tar.gz | tar xzf - && \
cd docker-compose && docker compose up -d

Open http://localhost:8080/login and log in with these credentials:

  • Username: jane
  • Password: some-other-secret-password

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@JakeSCahill JakeSCahill requested a review from a team as a code owner December 20, 2024 10:25
Copy link

netlify bot commented Dec 20, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit f37de1b
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67a21ed84a61260008614f66
😎 Deploy Preview https://deploy-preview-937--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JakeSCahill JakeSCahill marked this pull request as draft December 20, 2024 10:28
@JakeSCahill JakeSCahill marked this pull request as ready for review December 20, 2024 13:37
@JakeSCahill
Copy link
Contributor Author

Tests are failing because of a bug in how screenshot sizes are calculated. We are tracking the issue here: doc-detective/doc-detective-core#260

@Feediver1
Copy link
Contributor

Hi @JakeSCahill Is there an updated review deadline?

@JakeSCahill
Copy link
Contributor Author

Hi @JakeSCahill Is there an updated review deadline?

Just updated it - thanks!

@JakeSCahill JakeSCahill changed the title Single quickstart that uses Enterprise features Unified quickstart that uses Enterprise features Jan 15, 2025

== Start streaming

To start building a basic streaming application, you can use the `rpk` command-line tool to create a topic, produce messages to it, and consume messages from it.
To start building a basic streaming application, you can use the Redpanda CLI (`rpk`) to create a topic, produce messages to it, and consume messages from it. Each Redpanda broker comes preinstalled with `rpk`, so you can use it inside one of the Redpanda broker's Docker containers.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you should intro this section by saying that you can do all of this in either Redpanda Console or in rpk. Maybe even show example of one of the steps doing it both ways.

@JakeSCahill JakeSCahill requested a review from micheleRP January 23, 2025 09:30
Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

Approving for docs: works beautifully! Let me know if you want me to eyeball it again if you get much feedback from reviewers.

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.

4 participants