add build and getting started docs to readme #37
Conversation
analogrelay
requested review from
halter73,
Tratcher,
stephentoub,
karelz and
samsp-msft
README.md
Outdated
| 1. For CMD, there is no supported script. You can manually add the `.dotnet` directory **within this repo** to your `PATH`. Ensure `where dotnet` shows a path within this repository! | ||
| 1. Launch VS, VS for Mac, or VS Code! | ||
|
|
||
| As a short-cut, you can also just run the `startvs.cmd` script to launch Visual Studio on Windows. There's no need to use the `activate` script in that case. |
There was a problem hiding this comment.
I guess I wanted to give the details first? But sure, I'll reorder.
README.md
Outdated
|
|
||
| # Getting started | ||
|
|
||
| Coming Soon | ||
| Take a look at the [Sample App](samples/ReverseProxy.Sample), which configures a proxy to route traffic on all paths to a single backend server (the example backend server is [provided as well](samples/SampleServer)). We'll be publishing more docs and tutorials as the project develops! |
There was a problem hiding this comment.
Might want to be less specific here, this sample is going to churn.
There was a problem hiding this comment.
Ok, I'll just reference the samples exist. We should consider putting a README in that directory and trying to keep it somewhat up to date as we churn.
README.md
Outdated
| 1. "Dot-source" the `activate` script to put the local .NET SDK on the PATH | ||
| 1. For PowerShell, run: `. .\activate.ps1` (note the leading `. `, it is required!) | ||
| 1. For Linux/macOS/WSL, run: `. .\activate.sh` | ||
| 1. For CMD, there is no supported script. You can manually add the `.dotnet` directory **within this repo** to your `PATH`. Ensure `where dotnet` shows a path within this repository! |
There was a problem hiding this comment.
Low Pri: We could do something like the old VS Command Line feature that gives you a shell window with the right paths and other environment vars set up?
There was a problem hiding this comment.
Cancel that, the startVS is better.
There was a problem hiding this comment.
Well, and . .\activate.ps1 basically turns your current PowerShell into an equivalent to the VS Command Line (it puts the right dotnet.exe on your PATH). With the added benefit that there's a deactivate function to turn it off again.
README.md
Outdated
| There is some debate whether YARP stands for "Yet Another Reverse Proxy", or "YARP a Reverse Proxy", but either way it's a project to create a reverse proxy server. You may ask whether the world needs another | ||
| reverse proxy, but we found a bunch of internal teams at Microsoft who were either building one for their service | ||
| or had been asking about APIs and tech for building one, so we decided to get them all together to work on a common solution, this project. | ||
| There is some debate whether YARP stands for "Yet Another Reverse Proxy", or "YARP a Reverse Proxy", but either way it's a project to create a reverse proxy server. You may ask whether the world needs another reverse proxy, but we found a bunch of internal teams at Microsoft who were either building one for their service or had been asking about APIs and tech for building one, so we decided to get them all together to work on a common solution, this project. |
There was a problem hiding this comment.
There is some debate whether YARP stands for "Yet Another Reverse Proxy", or "YARP a Reverse Proxy"
I left feedback in the OneNote draft of this, but I think this intro should change. We should just state which it means (and "Yet Another Reverse Proxy" feels a bit self-deprecating to me).
There was a problem hiding this comment.
I'm open to changing it, but would appreciate @samsp-msft's feedback.
"Yet Another Reverse Proxy" feels a bit self-deprecating to me
Agreed. That's the main reason reason I prefer "YARP: A Reverse Proxy" as the expansion 😆. Judicious use of self-deprecation can be good, but coming out of the gate saying "Hey, we're just another reverse proxy" gives off a "you can just ignore this" and Not-Invented-Here vibe to me.
There was a problem hiding this comment.
Its a long running trend to do YAxx when you are producing an unoriginal concept - https://en.wikipedia.org/wiki/Yet_another. Given we have some catching up to do, I think its applicable.
There was a problem hiding this comment.
So our reverse proxy is "confessedly unoriginal"? Why are we doing it then?
|
Last call, going to rebase/resolve conflicts and merge after we get the build. |
analogrelay
force-pushed
the
anurse/readme-updates
branch
from
aba21e0 to
a0e8c49
Compare
analogrelay
added
the
Auto-Merge
|
Hello @anurse! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
ghost
merged commit 
I also flattened the extra newlines in the first paragraph.