Skip to content

docs: create link.md #3903

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 1 commit into from
Aug 6, 2021
Merged

docs: create link.md #3903

merged 1 commit into from
Aug 6, 2021

Conversation

ashumz
Copy link
Contributor

@ashumz ashumz commented Aug 5, 2021

link to --link docs from README to separate docs entry

docs/link.md Outdated
@@ -0,0 +1,8 @@
### code-server --link
Copy link
Contributor

Choose a reason for hiding this comment

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

since this is a top-level page, this should be a h1 heading

also, since it's a new page, we need to add it to the docs manifest or else it won't be navigable

@jsjoeio jsjoeio changed the title Create link.md docs: create link.md Aug 5, 2021
Copy link
Contributor

@jsjoeio jsjoeio left a comment

Choose a reason for hiding this comment

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

Thanks for doing this @ashumz 🙌

So like Jonathan said, we'll need to add to do a couple of things:

  • add to /docs/manifest.json
  • format using yarn fmt locally
  • clean up commits (mind squashing into one commit?)

I think that should be it! Let us know how we can help too

Run code-server with the beta flag `--link` and you'll get TLS, authentication, and a dedicated URL
for accessing your IDE out of the box.

```shell-session
Copy link
Contributor

Choose a reason for hiding this comment

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

@ashumz
Copy link
Contributor Author

ashumz commented Aug 5, 2021

I'd appreciate help with those things @jsjoeio. Not really sure how the manifest.json file works and don't have a ton of time to spend trying to figure it out if it's easy for someone else to push to the finish line. 🙏

@jsjoeio
Copy link
Contributor

jsjoeio commented Aug 6, 2021

Id appreciate help with those things @jsjoeio . Not really sure how the manifest.json file works and don't have a ton of time to spend trying to figure it out if it's easy for someone else to push to the finish line. 🙏

I'm on it!

@jsjoeio jsjoeio added the docs Documentation related label Aug 6, 2021
@jsjoeio jsjoeio added this to the 3.11.1 milestone Aug 6, 2021
link to --link docs from README to separate docs entry
@jsjoeio jsjoeio force-pushed the separate-link-docs branch from 751e911 to 8c70dfa Compare August 6, 2021 18:20
Copy link
Contributor

@jsjoeio jsjoeio left a comment

Choose a reason for hiding this comment

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

Made changes, looks good now!

@jsjoeio jsjoeio marked this pull request as ready for review August 6, 2021 18:21
@jsjoeio jsjoeio requested a review from a team as a code owner August 6, 2021 18:21
@jsjoeio jsjoeio requested a review from jawnsy August 6, 2021 18:21
@codecov
Copy link

codecov bot commented Aug 6, 2021

Codecov Report

Merging #3903 (1ff9d30) into main (7338037) will not change coverage.
The diff coverage is n/a.

❗ Current head 1ff9d30 differs from pull request most recent head 8c70dfa. Consider uploading reports for the commit 8c70dfa to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3903   +/-   ##
=======================================
  Coverage   63.51%   63.51%           
=======================================
  Files          36       36           
  Lines        1872     1872           
  Branches      379      379           
=======================================
  Hits         1189     1189           
  Misses        580      580           
  Partials      103      103           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7338037...8c70dfa. Read the comment docs.

@jsjoeio jsjoeio enabled auto-merge August 6, 2021 18:26
@jsjoeio jsjoeio merged commit c2af5a2 into main Aug 6, 2021
@jsjoeio jsjoeio deleted the separate-link-docs branch August 6, 2021 19:26
@ashumz
Copy link
Contributor Author

ashumz commented Aug 7, 2021

Hey @jsjoeio - much appreciation for taking this under your wing. Unfortunately the destination link is 404'ing for me - https://coder.com/docs/code-server/v3.11.0/link

Not sure how the manifest file works, but could it be from the -- characters in the title? 🤷‍♀️ Thanks for your help!

@jsjoeio
Copy link
Contributor

jsjoeio commented Aug 9, 2021

@ashumz - thanks for pointing that out and sorry you caught that before we did! I think it was a misunderstanding on our side with how the docs are generated. We'll work with @BrunoQuaresma to get it fixed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants