minor changes to README and github issue templates

Summary: see title

Reviewed By: isunjin

Differential Revision: D18838893

fbshipit-source-id: 17b888d8a6e1485ac36efed53c6bc22f6fb2c9d7

Author: Kiuk Chung

.github/ISSUE_TEMPLATE/bug-report.md

@@ -8,6 +8,21 @@ about: Submit a bug report to help us improve PyTorch Elastic
 
 <!-- A clear and concise description of what the bug is. -->
 
+Component (check all that applies):
+ * [ ] `state api`
+ * [ ] `train_step api`
+ * [ ] `train_loop`
+ * [ ] `rendezvous`
+ * [ ] `checkpoint`
+ * [ ] `rollback`
+ * [ ] `metrics`
+ * [ ] `petctl`
+ * [ ] `examples`
+ * [ ] `docker`
+ * [ ] other
+ 
+
+
 ## To Reproduce
 
 Steps to reproduce the behavior:
@@ -24,30 +39,17 @@ Steps to reproduce the behavior:
 
 ## Environment
 
- - What commands did you use to install torchelastic (conda/pip/build from source)?
- - If you are building from source, which commit is it?
- - What does `classy_vision.__version__` print? (If applicable)
-
-Please copy and paste the output from the Pytorch
-[environment collection script](https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py)
-(or fill out the checklist below manually).
-
-You can get the script and run it with:
-```
-wget https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py
-# For security purposes, please check the contents of collect_env.py before running it.
-python collect_env.py
-```
-
- - PyTorch Version (e.g., 1.0):
+ - torchelastic version (e.g. 0.1.0rc1):
  - OS (e.g., Linux):
- - How you installed PyTorch (`conda`, `pip`, source):
+ - How you installed torchelastic (`conda`, `pip`, source, `docker`):
+ - Docker image and tag (if using docker):
  - Build command you used (if compiling from source):
+ - Git commit (if installed from source):
  - Python version:
  - CUDA/cuDNN version:
  - GPU models and configuration:
- - Any other relevant information:
  - Execution environment (on-prem, aws, etc):
+ - Any other relevant information:
 
 ## Additional context
 

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,24 +1,25 @@
 ---
 name: "\U0001F680Feature Request"
-about: Submit a proposal/request for a new PyTorch Elastic feature
+about: Submit a proposal/request for a new feature or enhancement
 
 ---
 
-## 🚀 Feature
-<!-- A clear and concise description of the feature proposal -->
+## Description
+<!-- concise description of the feature/enhancement -->
 
-## Motivation
+## Motivation/Background
+<!-- why is this feature/enhancement important? provide background context -->
 
-<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->
 
-## Pitch
+## Detailed Proposal
+<!-- provide a detailed proposal -->
 
-<!-- A clear and concise description of what you want to happen. -->
 
 ## Alternatives
+<!-- discuss the alternativese considered and their pros/cons -->
 
-<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
 
-## Additional context
+## Additional context/links
+<!-- link to code, documentation, etc -->
+
 
-<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/questions-help-support.md

@@ -6,6 +6,22 @@ about: Do you need support? We have resources.
 
 ## ❓ Questions and Help
 
+
 ### Please note that this issue tracker is not a help form and this issue will be closed.
 
-We have a set of [listed resources available on the website]. TODO: Fill this up.
+Before submitting, please ensure you have gone through our documentation. Here
+are some links that may be helpful:
+
+* [What is torchelastic?](../../README.md)
+* [Quickstart on AWS](../../aws/README.md)
+* [Usage](../../USAGE.md)
+* [Examples](../../examples/README.md)
+* API documentation
+    * [Overview](../../USAGE.md)
+    * [Rendezvous documentation](../../torchelastic/rendezvous/README.md)
+    * [Checkpointing documentation](../../torchelastic/checkpoint/README.md)
+* [Configuring](../../USAGE.md#configuring)
+
+  
+### Question
+<!-- your question here -->

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -105,12 +105,6 @@ in the rendezvous module.
 Please refer to the [usage documentation](USAGE.md) for details on how to write
 and configure a torchelastic job.
 
-## Join the torchelastic community
-* Website: 
-* Facebook page:
-* Mailing list
-* irc: 
-
 See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
 
 ## License

README.md

@@ -140,6 +140,8 @@ Log into the AWS CloudWatch Logs console. You should see a log group called
 name `$job_name/$instance_id` (e.g. `my_job/i0b938EXAMPLE`).
 
 #### Troubleshooting
+
+##### SSH
 To SSH onto the worker nodes to debug/inspect the worker process use AWS 
 Session Manager instead of the ec2 key pair. [Install](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)
  the Session Manager plugin and run
@@ -154,6 +156,7 @@ awscli ssm start-session --target <instance_id>
 awscli ssm start-session --target i-00b00EXAMPLE
 ```
 
+##### Process Status and Logs
 Once SSH'ed, the workers run in a docker container managed by `systemd`.
 You can take a look at their console outputs by running
 
@@ -178,6 +181,10 @@ sudo systemctl start torchelastic_worker
 > **EXCERCISE:** Try stopping or adding worker(s) to see elasticity in action!
 To add workers, simply increase the `desired` size of the worker autoscaling group.
 
+##### Notable Directories
+1. torchelastic_worker systemd: `/etc/systemd/service/torchelastic_worker.service`
+2. torchelastic run scripts: `/var/torchelastic`
+
 
 > **Note**: by design, `petctl` tries to use the least number of AWS services. This
 was done intentionally to allow non-AWS users to easily transfer the functionality