FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Revamp docs by nhooyr · Pull Request #1628 · coder/code-server · GitHub

  1. coder
  2. code-server

Repository navigation

Revamp docs - #1628

Merged
nhooyr merged 27 commits into
masterfrom
docs
May 17, 2020
ConversationCommits (27)ChecksFiles changed
Merged

Revamp docs#1628
nhooyr merged 27 commits into
masterfrom
docs

Conversation

nhooyr commented May 12, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • Revamp README.md
  • Finish ./doc/guide.md
  • Clarify npm install deps

nhooyr requested a review from code-asher as a code owner May 12, 2020 05:40
nhooyr force-pushed the docs branch 2 times, most recently from 03ad916 to f656ecd Compare May 12, 2020 05:56
nhooyr commented May 12, 2020
View reviewed changes
Comment thread README.md
@@ -1,47 +1,93 @@
# code-server

nhooyr May 12, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@code-asher only review README.md for now pls

nhooyr force-pushed the docs branch 2 times, most recently from e53f1ce to 67de202 Compare May 12, 2020 06:01

nhooyr commented May 12, 2020

Copy link
Copy Markdown
Contributor Author

should split test into fmt, lint and test.

code-asher reviewed May 12, 2020
View reviewed changes

code-asher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

README.md is looking good. I think we might want to do something about the hardcoded version number so users aren't copy-pasting and installing old versions. Maybe we just update the readme as part of the release process?

Comment thread README.md
```bash
npm install -g code-server
code-server
```

code-asher May 12, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

To match the others should we put the Now visit line here?

nhooyr May 12, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Opted against so that user's would read the output but I'll add for visual consistency.

code-asher May 12, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

That makes sense.

nhooyr force-pushed the docs branch 4 times, most recently from e775804 to f26337e Compare May 13, 2020 00:00
nhooyr added 3 commits May 12, 2020 21:26
Revamp README.md with new installation options
41d625a
CI fixes
4aae5ea 
- Splits up test into fmt, lint and test
- Fixes bug in build-packages.sh
- Minor README.md fixes
Mention update of versions in README install examples
502c262

nhooyr commented May 13, 2020

Copy link
Copy Markdown
Contributor Author

So idk wtf is going on with both npm/yarn, but you can't publish any node_modules folders in a module. So now we rename them all to node_modules.bundled and then on post install rename them back.

Also have to unset some environment variables for npm rebuild to work under npm -g. Now all works well :)

nhooyr commented May 13, 2020

Copy link
Copy Markdown
Contributor Author

Punting windows release for now, this stuff took a lot longer than expected. Going to just finish this guide and then we should release.

nhooyr commented May 13, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author
  • If npm rebuild fails, should print a link to our npm docs

nhooyr commented May 13, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

- [ ] Discuss 8443 as default port or enabling TLS by default and using 443 potentially 🤔

We'll do this with the move to the Go CLI and all the changes to be made there @code-asher

nhooyr commented May 13, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author
  • Move old extension directory on macOS

Use .tar.gz for macOS releases
d563816 
No good reason to use .zip, was just confusion on my part.
nhooyr force-pushed the docs branch 8 times, most recently from fe47544 to 977c27c Compare May 16, 2020 19:20
nhooyr force-pushed the docs branch 4 times, most recently from 9d70316 to 2b3eabb Compare May 17, 2020 22:00
nhooyr merged commit e955da1 into master May 17, 2020
nhooyr deleted the docs branch May 17, 2020 23:46
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

code-asher code-asher left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL