[Docs] Cleanup docs on contributing #369
Conversation
Signed-off-by: Sarah McClure <[email protected]>
|
|
@smcclure20 thanks for getting the ball rolling on this. Let me make some further cuts and I'll push it to this branch. |
|
|
||
| You can easily do this from the command shell with ``code .``, which opens the current directory as a folder in VS Code. | ||
|
|
||
|
|
||
| Using the Dev Container |
There was a problem hiding this comment.
I am not sure it's that great to remove the editor section completely. Someone new on one or more dimensions (new to Go, or new VS Code) could find this information useful. I would probably just make it a single paragraph like:
| Using the Dev Container | |
| Editor | |
| -------------------- | |
| You can use your favorite editor set up for Go. If you don't have one, we recommend `Visual Studio Code <https://code.visualstudio.com/>`_ with its `Go extension <https://marketplace.visualstudio.com/items?itemName=golang.go>`_. | |
| Using the Dev Container |
|
@seankimkdy Any progress on this? |
Signed-off-by: Sean Kim <[email protected]>
Signed-off-by: Sean Kim <[email protected]>
Signed-off-by: Sean Kim <[email protected]>
|
@smcclure20 I added some changes. Let me know what you think. My philosophy was to remove a lot of duplicate info (e.g., putting how to get help on every page) and beginner level info (e.g., installing make is something I believe most contributors would know how to do). I also think we need another reviewer to approve since we both edited the PR, so if @divega or @praveingk could review that'd be great. |
| Known Issues | ||
| ------------- | ||
|
|
||
| ``gopls`` Linting Issue in Testing Files on Package Declaration Line |
There was a problem hiding this comment.
Should we still have a record of this somewhere?
There was a problem hiding this comment.
Yea I actually put this under the VS Code setup. I realized t's not so much of an issue but rather a config.
|
|
||
| **Google Cloud** | ||
| Google Cloud | ||
| ^^^^^^^^^^^^ |
There was a problem hiding this comment.
In the below, I am confused by the second bullet under the last numbered point. Isn't it that you choose this if you want to not delete the project? I think the beginning of the point doesn't really capture that. I would then also specifically say that you must then delete everything on your own, and here is the order to do that.
There was a problem hiding this comment.
Not exactly. For not deleting the project, we have PARAGLIDER_TEST_PERSIST which I have in the section below. If you use PARAGLIDER_GCP_PROJECT, then the project by default isn't deleted (regardless of the value of PARAGLIDER_TEST_PERSIST. I added some more wording. Let me know if that's still confusing.
|
|
||
| Using the Dev Container | ||
| ------------------------ | ||
| Dev Containers allow you to run a development environment using VS Code inside a container. If you want to try this: |
There was a problem hiding this comment.
Is it still valuable to at least have the pre-reqs for the dev container? Or is it explained enough in what you link above?
There was a problem hiding this comment.
The link is the official VS Code guideline, but I think you're right in that this short statement would be helpful as dev containers are not expected knowledge. I updated the wording under "VS Code Setup".
Signed-off-by: Sean Kim <[email protected]>
Signed-off-by: Sean Kim <[email protected]>
Signed-off-by: Sean Kim <[email protected]>
Signed-off-by: Sean Kim <[email protected]>
There was a problem hiding this comment.
@smcclure20, @seankimkdy was there anything pending for this review or can we take it? I made a couple of minor comments.
|
|
||
| If you have a question, please visit our Discord (linked at the footer) to post your question and we'll get back to you ASAP |
There was a problem hiding this comment.
Nit:
| If you have a question, please visit our Discord (linked at the footer) to post your question and we'll get back to you ASAP | |
| If you have a question, please visit our Discord (linked at the footer) to post your question and we'll get back to you ASAP. |
|
|
||
| Our integration/multicloud tests perform real requests to cloud providers. You can run these with the following commands | ||
| You can run these with the following commands |
There was a problem hiding this comment.
| You can run these with the following commands | |
| You can run these with the following commands: |
Resolves #282
@seankimkdy, any other changes you think we should make?