+
Skip to content
This repository was archived by the owner on Aug 31, 2023. It is now read-only.

doc(rome_cli): Use permalinks in rome init #3550

Merged
merged 5 commits into from
Nov 2, 2022
Merged

Conversation

MichaReiser
Copy link
Contributor

Summary

This PR sets up static permalinks for the URLs used by the CLI so that changes to the website structure no longer require updating the CLI.

This PR also slightly improves the rendering of the rome init command.

Test Plan

  • I opened the permalinks from my browser and verified that they redirect me to the correct sections

Output of rome init

@MichaReiser MichaReiser added the A-CLI Area: CLI label Nov 2, 2022
@MichaReiser MichaReiser requested a review from leops as a code owner November 2, 2022 09:33
@MichaReiser MichaReiser requested a review from a team November 2, 2022 09:33
@MichaReiser MichaReiser temporarily deployed to netlify-playground November 2, 2022 09:33 Inactive
@MichaReiser MichaReiser changed the base branch from main to website/getting-started November 2, 2022 09:34
@netlify
Copy link

netlify bot commented Nov 2, 2022

Deploy Preview for rometools canceled.

Name Link
🔨 Latest commit 0a8dac7
🔍 Latest deploy log https://app.netlify.com/sites/rometools/deploys/636259db39537f0008122725

@MichaReiser MichaReiser mentioned this pull request Nov 2, 2022
11 tasks
@github-actions
Copy link

github-actions bot commented Nov 2, 2022

Base automatically changed from website/getting-started to main November 2, 2022 09:43
@MichaReiser MichaReiser temporarily deployed to netlify-playground November 2, 2022 09:44 Inactive
@xunilrj
Copy link
Contributor

xunilrj commented Nov 2, 2022

Wondering if we should support OSC8 for links.
https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#the-escape-sequence

@leops
Copy link
Contributor

leops commented Nov 2, 2022

Wondering if we should support OSC8 for links. https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#the-escape-sequence

That's actually already supported through the Hyperlink markup element, but I guess it may not be needed here if we rely on the terminal client automatically detecting links and making them clickable ?

@MichaReiser MichaReiser temporarily deployed to netlify-playground November 2, 2022 11:12 Inactive
@MichaReiser
Copy link
Contributor Author

I changed it to use Hyperlink instead. The downside is that the links are more difficult to spot

grafik

@MichaReiser MichaReiser temporarily deployed to netlify-playground November 2, 2022 11:32 Inactive
@xunilrj
Copy link
Contributor

xunilrj commented Nov 2, 2022

I changed it to use Hyperlink instead. The downside is that the links are more difficult to spot

You probably want this to make it more readable, right?

 <Hyperlink href="https://rome.tools/docs">"https://rome.tools/docs"</Hyperlink>

@MichaReiser
Copy link
Contributor Author

I changed it to use Hyperlink instead. The downside is that the links are more difficult to spot

You probably want this to make it more readable, right?

 <Hyperlink href="https://rome.tools/docs">"https://rome.tools/docs"</Hyperlink>

How's that different to what the CLI does by default? Overall, having the inline links makes the message easier to read.

@xunilrj
Copy link
Contributor

xunilrj commented Nov 2, 2022

How's that different to what the CLI does by default? Overall, having the inline links makes the message easier to read.

It will make the URL clickable if the terminal supports the extension and do not search for urls. Otherwise will be the same.

@MichaReiser MichaReiser temporarily deployed to netlify-playground November 2, 2022 11:51 Inactive
@MichaReiser MichaReiser merged commit 3cf066d into main Nov 2, 2022
@MichaReiser MichaReiser deleted the doc/init-permalink branch November 2, 2022 13:11
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-CLI Area: CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载