Skip to content

feat(site): add numbers to SSHButton content for clarity #15661

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

Merged
merged 8 commits into from
Dec 12, 2024

Conversation

benwinding
Copy link
Contributor

Summary

So when I first used this, I stupidly didn't realize that you needed to do both steps. This PR adds numbers to the commands to make that a little clearer 🙏

Screenshots

Before After
- Note numbers next to steps
image image

@cdr-bot cdr-bot bot added the community Pull Requests and issues created by the community. label Nov 26, 2024
@matifali matifali changed the title Add numbers to SSHButton content for clarity feat(site): add numbers to SSHButton content for clarity Nov 26, 2024
@matifali matifali requested review from a team and aslilac and removed request for a team November 26, 2024 11:22
@aslilac
Copy link
Member

aslilac commented Nov 27, 2024

if we're to stylize this as a list, we should probably do it semantically (<ol>, <li>, list-style-type) rather than just putting the numbers in directly

Comment on lines 85 to 92
const SSHStep = (props: { helpText: string; codeExample: string }) => (
<li style={{ listStylePosition: "inside" }}>
<HelpTooltipText style={{ display: "inline" }}>
<strong css={styles.codeExampleLabel}>Connect to the agent:</strong>
</HelpTooltipText>
<CodeExample secret={false} code={props.codeExample} />
</li>
);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for reviewing @aslilac 🙏

Changed to use semantic HTML <li> tags (did it naively to reduce changes, but agree semantic html is better)

image

@dannykopping
Copy link
Contributor

dannykopping commented Dec 2, 2024

recheck

(retriggered CLA job, since it failed)

Edit: nope, that didn't work; looking into what's going on.

@benwinding did you sign the CLA?

@benwinding
Copy link
Contributor Author

Hi @dannykopping 👋

@benwinding did you sign the CLA?

Sorry just getting permission from my company to sign the CLA, will comment an update when it's signed 🙏

Copy link
Member

@aslilac aslilac left a comment

Choose a reason for hiding this comment

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

Typically we declare the props type as a separate statement, use the FC type, and use argument destructuring to get the props values, like so:

export interface SSHButtonProps {
	workspaceName: string;
	agentName: string;
	sshPrefix?: string;
}

export const SSHButton: FC<SSHButtonProps> = ({
	workspaceName,
	agentName,
	sshPrefix,
}) => {

SSHStep should do the same.

@matifali matifali requested a review from aslilac December 9, 2024 12:37
Copy link
Member

@aslilac aslilac left a comment

Choose a reason for hiding this comment

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

@matifali I already reviewed this, I'm waiting for the last review to be addressed.

@benwinding benwinding requested a review from aslilac December 9, 2024 23:21
Copy link
Member

@aslilac aslilac left a comment

Choose a reason for hiding this comment

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

Typically we declare the props type as a separate statement, use the FC type, and use argument destructuring to get the props values, like so:

Still needs this addressed, but otherwise looks good!

@benwinding benwinding requested a review from aslilac December 10, 2024 22:58
@aslilac
Copy link
Member

aslilac commented Dec 11, 2024

@dannykopping @deansheather this pr is ready to go, we're just waiting on the cla. can one of you help with that since the bot isn't working?

@deansheather
Copy link
Member

Hi @benwinding could you please comment the following once you've read and agree to the CLA document?

I have read the CLA Document and I hereby sign the CLA

We've have some issues with the CLA bot over the last week or so, so I apologize that we have to do it the manual way

@benwinding
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

Copy link

github-actions bot commented Dec 12, 2024

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

deansheather added a commit to coder/cla that referenced this pull request Dec 12, 2024
@deansheather
Copy link
Member

recheck

@deansheather deansheather merged commit 737205e into coder:main Dec 12, 2024
26 of 28 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 12, 2024
@deansheather
Copy link
Member

Thanks for your contribution! Sorry about the difficulties merging due to the CLA bot issues 🙇

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
community Pull Requests and issues created by the community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants