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

Command Formatting Issue on compatible_oci_registries.mdx #446

Closed
1 task done
7h3-3mp7y-m4n opened this issue Dec 29, 2024 · 2 comments · Fixed by #448
Closed
1 task done

Command Formatting Issue on compatible_oci_registries.mdx #446

7h3-3mp7y-m4n opened this issue Dec 29, 2024 · 2 comments · Fixed by #448

Comments

@7h3-3mp7y-m4n
Copy link
Contributor

Code of Conduct

What part of document/web-page on oras.land is affected?

The current documentation uses $ prefix in the command example here

$ mkdir -p certs
$ openssl req \
-newkey rsa:4096 -nodes -sha256 -keyout certs/domain.key \
-x509 -days 365 -out certs/domain.crt
```

if we copy from it will create a genuine error like this
Screenshot 2024-12-29 at 10 27 57 PM
It would be better if we could change it like this
mkdir -p certs openssl req \ -newkey rsa:4096 -nodes -sha256 -keyout certs/domain.key \ -x509 -days 365 -out certs/domain.crt
or divide it into multiple commands ...

Additional comments?

If the issue is valid then I would love to work on it, Thanks!

@TerryHowe
Copy link
Member

Sounds good if there was a command separator in there.

Would you like to open a PR? Thanks!

@7h3-3mp7y-m4n
Copy link
Contributor Author

for sure!:)

TerryHowe pushed a commit that referenced this issue Jan 2, 2025
### Fixes #446 
As the documentation uses the `$` prefix in the command here
https://github.com/oras-project/oras-www/blob/4e73bda9c69b1a31c0ddd345f01b35c0249b763e/versioned_docs/version-1.2/compatible_oci_registries.mdx?plain=1#L89-L93

Which causes an error while using the terminal, After adding a separator
it works fine...

### preview after fixing
<img width="826" alt="Screenshot 2024-12-31 at 1 53 52 AM"
src="https://github.com/user-attachments/assets/2658116c-93a9-45c3-aaad-f771bf264140"
/>

Signed-off-by: 7h3-3mp7y-m4n <[email protected]>
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 a pull request may close this issue.

2 participants