Fix : recreate the termux guide to adapt the recent changes #4472

arHSM · 2021-11-09T06:59:02Z

Termux nodejs-lts changed from v14 to v16 and there are many issues people are facing such as with argon2. Hence I recommend changing it to this install process which is comparably better and has one less issue :^)

I've also added some extra things such as installing GO and Python, idk about the TOC tree but this is pretty much it.

Fixes
Sort of fixes
#4415
#4470
#4394

Termux nodejs-lts changed from v14 to v16 and there are many issues people are facing such as with argon2. Hence I recommend changing it to this install process which is comparably better and has one less issue :^) I've also added some extra things such as installing GO and Python, idk about the TOC tree but this is pretty much it.

im-coder-lg · 2021-11-09T14:29:00Z

@arHSM this is good! @jsjoeio you can sanction the checks. @arHSM be sure to:

Clone locally, run yarn fmt rebase(use the GitHub UI and merge the latest commits), and push the change up here
not get scared that the docs are failing, since you edited on a fork, you don't have the tokens to publish changes to Coder's Vercel deployment, but it's not required. The build, e2e tests and pre-build checks are required though.

arHSM · 2021-11-09T15:26:42Z

Ok its night rn, will do tomorrow

im-coder-lg · 2021-11-10T03:24:24Z

Okay, now, do these steps:

Clone this repo and open a new tab with your code-server fork, and remember, be on your PR branch, ie: arHSM:patch-2
Open your terminal of choice, make sure Node JS and Yarn is installed, the CLI works and on your terminal, run yarn install && yarn fmt.
While it is running, switch to your branch inside your fork, and check for a Fetch and merge option. Fetch and merge the latest commits, and push the yarn fmt result here(there will be a minor change which is important)

Then, wait for the checks to complete(if it doesn't, wait for a reply from @jsjoeio, he will help on this.)

im-coder-lg · 2021-11-10T03:31:18Z

Oh no, only a maintainer can change the docs! Since a maintainer has access to the repo!

Let me explain elaborately. Imagine, just imagine that I am a maintainer of code-server. I'd have access to:

the repo itself
Coder's Vercel deployment(Coder.com)
Secret tokens

So, it means that if I make a docs edit, I'd make it from inside the repo since we need the tokens(secret) so that the tokens are applied. Whenever I try merging another branch inside code-server to the main branch, I'd get a docs deployment reply, I'd follow steps on making the PR, like running yarn fmt locally, etc.
(Note: Imagination ends here)

So, if the docs are approved+the docs check finally works, great! If it doesn't, either the PR can get merged, or a maintainer can make the PR and we can review, which is better.

#4472 (comment)

im-coder-lg · 2021-11-10T07:39:50Z

Now, merge the latest commits from the base branch to your PR branch. This would help with merging.

arHSM · 2021-11-10T07:43:51Z

looks good

jsjoeio

Hi @arHSM!

First, thank you so much for your PR ♥️ We really appreciate it.

I think there is some hesitation with this doc change mainly because it feels like it introduces a lot of extra steps compared to our previous guide. I'm wondering if we could find a happy middle ground?

The Installing Python and Go additions are fantastic! I'm wondering if we can simplify this guide somehow. In my head, I'm thinking something like:

Get Termux
Install dependencies (i.e. Node/npm, nvm)
Install code-server
Run code-server
Do you think it's possible to keep it as simple as that? I'd rather us not suggest switching users or doing much beyond those four steps but maybe it's not possible due to our current limitations.

Let us know!

jsjoeio · 2021-11-10T16:58:10Z

docs/termux.md

-  - [Backspace doesn't work](#backspace-doesnt-work)
+  - [Git won't work in `/sdcard`](#git-wont-work-in-sdcard)
+- [Extra](#extra)
+  - [Install GO](#install-go)


Suggested change

- [Install GO](#install-go)

- [Install Go](#install-go)

codecov · 2021-11-10T17:06:37Z

Codecov Report

Merging #4472 (a0a00af) into main (cdf0deb) will not change coverage.
The diff coverage is n/a.

❗ Current head a0a00af differs from pull request most recent head f7f6e1b. Consider uploading reports for the commit f7f6e1b to get more accurate results

@@           Coverage Diff           @@
##             main    #4472   +/-   ##
=======================================
  Coverage   66.46%   66.46%           
=======================================
  Files          30       30           
  Lines        1625     1625           
  Branches      330      330           
=======================================
  Hits         1080     1080           
  Misses        463      463           
  Partials       82       82

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 cdf0deb...f7f6e1b. Read the comment docs.

arHSM · 2021-11-10T18:23:32Z

I'd rather us not suggest switching users or doing much beyond those four steps but maybe it's not possible due to our current limitations.

yeah i think we can remove those steps, but can we atleast add a note like "consider creating a new user instead of using root, read more [here](link to guide)"?

jsjoeio · 2021-11-10T18:59:31Z

yeah i think we can remove those steps, but can we atleast add a note like "consider creating a new user instead of using root, read more [here](link to guide)"?

Sure, if you think there's a specific use case that solves, we could definitely add that as a guide! The guide could even by "how to add a new user" or "why you should consider adding a new user"

…atch-2

arHSM · 2021-11-10T19:32:36Z

I have now removed those unnecessary steps and added a quote block at the end of the process stating the following

Consider using a new user instead of root, read here why using root is not recommended.
Learn how to add a user here.

and i also noticed that Install & Upgrade was ## and not ### so i made that change too

jsjoeio · 2021-11-10T19:56:57Z

docs/termux.md

+> Consider using a new user instead of root, read [here](https://www.howtogeek.com/124950/htg-explains-why-you-shouldnt-log-into-your-linux-system-as-root/) why using root is not recommended.\
+> Learn how to add a user [here](https://gist.github.com/arHSM/62242c343efc2827861ddc38e485d7df).


I'm not against using a gist here but if you accidentally delete it in the future, it breaks our docs 😛

What if we move this into it's own section under Extra? And then you can use the text directly instead of linking the gist.

jsjoeio · 2021-11-10T19:58:07Z

and i also noticed that Install & Upgrade was ## and not ### so i made that change too

you rock! I requested one last change and then I think we'll be good to go! ♥️

jsjoeio

Awesome! I think we're good to go once CI passes (ignore Docs Preview)

arHSM · 2021-11-10T20:56:20Z

Wait don't merge yet, I have found a typo in step 5

jsjoeio · 2021-11-10T22:26:18Z

@arHSM you give me the thumbs up when this is ready to merge!

* Fix : recreate the termux guide to adapt the recent changes Termux nodejs-lts changed from v14 to v16 and there are many issues people are facing such as with argon2. Hence I recommend changing it to this install process which is comparably better and has one less issue :^) I've also added some extra things such as installing GO and Python, idk about the TOC tree but this is pretty much it. * yarn-fmt and minor typos #4472 (comment) * Fix : replace unnecessary steps to be linked to a guide * Change from private gist to a section in Extra * Remove reference to non-existent step * ready to merge! Co-authored-by: Joe Previte <[email protected]>

* Refactor vscode router to load async. * Bump vscode. * fix volumes (#4497) * Fix : recreate the termux guide to adapt the recent changes (#4472) * Fix : recreate the termux guide to adapt the recent changes Termux nodejs-lts changed from v14 to v16 and there are many issues people are facing such as with argon2. Hence I recommend changing it to this install process which is comparably better and has one less issue :^) I've also added some extra things such as installing GO and Python, idk about the TOC tree but this is pretty much it. * yarn-fmt and minor typos #4472 (comment) * Fix : replace unnecessary steps to be linked to a guide * Change from private gist to a section in Extra * Remove reference to non-existent step * ready to merge! Co-authored-by: Joe Previte <[email protected]> Co-authored-by: Jinu <[email protected]> Co-authored-by: Han Seung Min - 한승민 <[email protected]> Co-authored-by: Joe Previte <[email protected]>

arHSM requested a review from a team as a code owner November 9, 2021 06:59

jsjoeio self-assigned this Nov 9, 2021

yarn-fmt and minor typos

ba0a6c9

#4472 (comment)

arHSM added 2 commits November 10, 2021 13:14

Merge branch 'main' into patch-2

2e9a8fb

Merge branch 'main' into patch-2

c4e1fb3

jsjoeio suggested changes Nov 10, 2021

View reviewed changes

arHSM added 2 commits November 11, 2021 00:58

Fix : replace unnecessary steps to be linked to a guide

6172acd

Merge branch 'patch-2' of https://github.com/arHSM/code-server into p…

2f4d54a

…atch-2

jsjoeio suggested changes Nov 10, 2021

View reviewed changes

Change from private gist to a section in Extra

becdb3a

jsjoeio approved these changes Nov 10, 2021

View reviewed changes

Remove reference to non-existent step

d530c32

arHSM and others added 2 commits November 11, 2021 10:24

ready to merge!

3d68666

Merge branch 'main' into patch-2

f7f6e1b

jsjoeio merged commit 6606040 into coder:main Nov 12, 2021

arHSM deleted the patch-2 branch November 24, 2021 09:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix : recreate the termux guide to adapt the recent changes #4472

Fix : recreate the termux guide to adapt the recent changes #4472

arHSM commented Nov 9, 2021 •

edited

Loading

im-coder-lg commented Nov 9, 2021

arHSM commented Nov 9, 2021

im-coder-lg commented Nov 10, 2021

im-coder-lg commented Nov 10, 2021 •

edited

Loading

im-coder-lg commented Nov 10, 2021 •

edited

Loading

arHSM commented Nov 10, 2021

jsjoeio left a comment

jsjoeio Nov 10, 2021

codecov bot commented Nov 10, 2021 •

edited

Loading

arHSM commented Nov 10, 2021

jsjoeio commented Nov 10, 2021

arHSM commented Nov 10, 2021 •

edited

Loading

jsjoeio Nov 10, 2021

arHSM Nov 10, 2021

jsjoeio commented Nov 10, 2021

jsjoeio left a comment

arHSM commented Nov 10, 2021

jsjoeio commented Nov 10, 2021

		> Consider using a new user instead of root, read [here](https://www.howtogeek.com/124950/htg-explains-why-you-shouldnt-log-into-your-linux-system-as-root/) why using root is not recommended.\
		> Learn how to add a user [here](https://gist.github.com/arHSM/62242c343efc2827861ddc38e485d7df).

Fix : recreate the termux guide to adapt the recent changes #4472

Fix : recreate the termux guide to adapt the recent changes #4472

Conversation

arHSM commented Nov 9, 2021 • edited Loading

im-coder-lg commented Nov 9, 2021

arHSM commented Nov 9, 2021

im-coder-lg commented Nov 10, 2021

im-coder-lg commented Nov 10, 2021 • edited Loading

im-coder-lg commented Nov 10, 2021 • edited Loading

arHSM commented Nov 10, 2021

jsjoeio left a comment

Choose a reason for hiding this comment

jsjoeio Nov 10, 2021

Choose a reason for hiding this comment

codecov bot commented Nov 10, 2021 • edited Loading

Codecov Report

arHSM commented Nov 10, 2021

jsjoeio commented Nov 10, 2021

arHSM commented Nov 10, 2021 • edited Loading

jsjoeio Nov 10, 2021

Choose a reason for hiding this comment

arHSM Nov 10, 2021

Choose a reason for hiding this comment

jsjoeio commented Nov 10, 2021

jsjoeio left a comment

Choose a reason for hiding this comment

arHSM commented Nov 10, 2021

jsjoeio commented Nov 10, 2021

arHSM commented Nov 9, 2021 •

edited

Loading

im-coder-lg commented Nov 10, 2021 •

edited

Loading

im-coder-lg commented Nov 10, 2021 •

edited

Loading

codecov bot commented Nov 10, 2021 •

edited

Loading

arHSM commented Nov 10, 2021 •

edited

Loading