fix: Expanded on "contributing to docs page" section : Doc - 87 (#161)

* expand collaboration page

* update add-resources page

* updated statement

* updated c

* updated issue template

* updated contents

* update to the resource page

* re-structure contribution section

* updated title

Author: krofax

ISSUE_TEMPLATE.md

@@ -1,25 +1,38 @@
+<!-- Thanks for reporting an issue! Please fill out the blanks below. -->
+
 <!--- Provide a general summary of the issue in the Title above -->
 
-🧾 Expected Behaviour
+## 🧾 Expected Behaviour
 
-<!--- If you're describing a bug, tell us what should happen --><!--- If you're suggesting a change/improvement, tell us how it should work -->
+<!--- If you're describing an error, tell us what should happen --><!--- If you're suggesting a change/improvement, tell us how it should work -->
 
 🔨 Current Behaviour
 
-<!--- If describing a bug, tell us what happens instead of the expected behaviour --><!--- If suggesting a change/improvement, explain the difference from current behaviour -->
+<!--- If describing an error in your integration, tell us what happens instead of the expected behaviour --><!--- If suggesting a change/improvement, explain the difference from current behaviour -->
 
 ## 🙋‍️ Possible Solution [optional]
 
-<!--- Not obligatory, but suggest a fix/reason for the bug, --><!--- or ideas how to implement the addition or change -->
+....
+
+<!--- Not obligatory, but suggest a fix/reason for the error, --><!--- or ideas on how to implement the addition or change -->
+
+## 📝 Steps to Reproduce (for errors)
 
-## 📝 Steps to Reproduce (for bugs)
+....
 
-<!--- Provide a link to a live example, or an unambiguous set of steps to --><!--- reproduce this bug. Include code to reproduce, if relevant -->1.2.3.4.
+<!--- Provide a link to a live example or an unambiguous set of steps to --><!--- reproduce this bug. Include code to reproduce, if relevant -->1.2.3.4.
 
-## 🖥 Context
+## 🖥 Context: What were you expecting to happen?
+
+....
 
 <!--- How has this issue affected you? What are you trying to accomplish? --><!--- Providing context helps us come up with a solution that is most useful in the real world -->
 
+## ❌ Any logs, error output, etc?
+<!-- If it’s long, please paste to https://gist.github.com/ and insert the link here. -->
+
+> Link to your issue / project:
+
 ## 🔩 Your Environment
 
 <!--- Include as many relevant details about the environment you experienced the bug in -->
@@ -28,7 +41,10 @@
 * Browser Name and version:
 * Operating System and version (desktop or mobile):
 
-> Link to your issue / project:
+## ✅ Acceptance criteria
 
+....
 
-## ✅ Acceptance criteria
+## Any other comments?
+
+....

docs/.vuepress/config.js

@@ -72,7 +72,11 @@ module.exports = {
           title: "Getting started",
           path: "/dev/fundamentals",
           collapsable: false,
-          children: ["/dev/fundamentals/rollups.md", "/dev/fundamentals/zkSync.md", "/dev/fundamentals/testnet.md", "/dev/fundamentals/faq.md"],
+          children: [
+            "/dev/fundamentals/rollups.md", 
+            "/dev/fundamentals/zkSync.md", 
+            "/dev/fundamentals/testnet.md", 
+            "/dev/fundamentals/faq.md"],
         },
         {
           title: "Understanding zkSync",
@@ -108,7 +112,10 @@ module.exports = {
           title: "Tutorials",
           path: "/dev/tutorials",
           collapsable: false,
-          children: ["/dev/tutorials/cross-chain-tutorial.md", "/dev/tutorials/custom-aa-tutorial.md", "/dev/tutorials/custom-paymaster-tutorial.md"],
+          children: [
+          "/dev/tutorials/cross-chain-tutorial.md", 
+          "/dev/tutorials/custom-aa-tutorial.md", 
+          "/dev/tutorials/custom-paymaster-tutorial.md"],
         },
         {
           title: "Troubleshooting",
@@ -118,7 +125,7 @@ module.exports = {
             "/dev/troubleshooting/important-links.md",
             "/dev/troubleshooting/status.md",
             "/dev/troubleshooting/docs-contribution/docs.md",
-            "/dev/troubleshooting/docs-contribution/edit-doc.md",
+            "/dev/troubleshooting/docs-contribution/community-resources.md",
             "/dev/troubleshooting/known-issues.md",
           ],
         },
@@ -186,14 +193,21 @@ module.exports = {
           path: "/api/hardhat", // optional, which should be a absolute path.
           collapsable: false, // optional, defaults to true
           sidebarDepth: 1,
-          children: ["/api/hardhat/getting-started", "/api/hardhat/plugins", "/api/hardhat/testing", "/api/hardhat/compiling-libraries"],
+          children: [
+            "/api/hardhat/getting-started", 
+            "/api/hardhat/plugins", 
+            "/api/hardhat/testing", 
+            "/api/hardhat/compiling-libraries"],
         },
         {
           title: "Block Explorer", // required
           path: "/api/tools/block-explorer", // optional, which should be a absolute path.
           collapsable: false, // optional, defaults to true
           sidebarDepth: 1, // optional, defaults to 1
-          children: ["/api/tools/block-explorer/intro", "/api/tools/block-explorer/block-view", "/api/tools/block-explorer/contract-verification"],
+          children: [
+            "/api/tools/block-explorer/intro", 
+            "/api/tools/block-explorer/block-view", 
+            "/api/tools/block-explorer/contract-verification"],
         },
       ],
     },

docs/dev/developer-guides/aa.md

@@ -297,7 +297,7 @@ The `zksync-web3` SDK provides [methods](../../api/js/utils.md#encoding-paymaste
 
 ### Testnet paymaster
 
-To let users experience using with paymasters on testnet, as well as to keep supporting paying fees in ERC20 tokens, the Matter Labs team provides the testnet paymaster, that enables paying fees in ERC20 token at a 1:1 exchange rate with ETH (i.e. one unit of this token is equal to 1 wei of ETH).
+To ensure users experience paymasters on testnet, as well as keep supporting paying fees in ERC20 tokens, the Matter Labs team provides the testnet paymaster, that enables paying fees in ERC20 token at a 1:1 exchange rate with ETH (i.e. one unit of this token is equal to 1 wei of ETH).
 
 The paymaster supports only the [approval based](#approval-based-paymaster-flow) paymaster flow and requires that the `token` param is equal to the token being swapped and `minAllowance` to equal to least `tx.maxFeePerErg * tx.ergsLimit`. In addition, the testnet paymaster does not make use of the `_innerInput` parameter, so nothing should be provided (empty `bytes`).
 

docs/dev/troubleshooting/README.md

@@ -7,4 +7,5 @@ Get brief explainers on your integration with zkSync.
 - [Important links](./important-links.md)
 - [Status](./status.md)
 - [Known issues](./known-issues.md)
-- [Contribute to documentation](./docs-contribution/docs.md)
+- [Contribute to documentation](./docs-contribution/docs.md)
+- [Contribute to Awesome zkSync repo](./docs-contribution/community-resources.md)

docs/dev/troubleshooting/docs-contribution/community-resources.md

@@ -0,0 +1,16 @@
+## Community resources
+
+We cannot promise to cover all aspects of zkSync so we will attempt to highlight some of the community's outstanding resources such as videos, tutorials, articles etc.
+
+The [Awesome zkSync repo](https://github.com/0xJuancito/awesome-zksync) is where community-based resources live.
+
+## Criteria for contributing
+To contribute to the Awesome zkSync repo, the following are some criteria to keep in mind:
+
+- Is the content resource current?
+- Is the content resource protected by a payment wall?
+- Is the information trustworthy? Is it based on facts or opinions?
+- How reputable is the author? Do they cite their references?
+- Does the content resource provide anything new or different from what can be found in the documentation?
+## Making your contribution
+If you find a content resource related to the zkSync ecosystem, be free to recommend its addition to the *Awesome zkSync repo* by making a pull request.

docs/dev/troubleshooting/docs-contribution/docs.md

@@ -11,4 +11,47 @@ As collaboration on contribution to zkSync documentation is such an integral par
     - If you find a problem with a specific page in the zkSync documentation, you can always [edit the page](./edit-doc.md) to fix it.
     - If you want to discuss a larger problem or propose a major change to the zkSync documentation, you can raise an [issue on Github](https://github.com/matter-labs/zksync-web-v2-docs/issues).
 - Share views and know the latest discussions on our [Community Forum](https://community.zksync.io/).
-- Follow zkSync on Twitter to get the latest happenings on zkSync.
+- Follow zkSync on Twitter to get the latest happenings on zkSync.
+
+## Ways to contribute
+
+- [Create or edit a page](#edit-or-review-a-documentation-page) - Improve on the existing pages or create a new one.
+- [Pick an issue and work on it](https://github.com/matter-labs/zksync-web-v2-docs/issues) - Work on issues that's has been raised.
+- [Add community resources](./community-resources.md) - Help us add relevant resources, such as videos, tutorials or articles.
+
+
+## Edit or review a documentation page
+
+### Goal
+Find a documentation page that you think needs updating, proofreading, or editing.
+
+### Background and reference information
+
+[Content style guide](https://www.notion.so/matterlabs/Communication-Strategy-a4836bd6d2254268b60a489d82992d71) - zkSync content style guide.
+
+### Categories of contribution
+
+Review the page, to see if it needs editing. Things to look for:
+1. Proofreading (spelling, grammar, punctuation).
+2. Does the particular page of interest follow the content style guide and the documentation structure guide, if it doesn't you can edit.
+3. 404 links - Make edits and create a PR to fix any broken links.
+4. Language translation - We will make a guide for you to follow if you want to translate zkSync documentation into a non-English language.
+
+### Detailed steps
+
+1. In the page of interest, click on `Edit this page`,
+2. Step 1 takes you to GitHub: either create an account on [GitHub](https://github.com/join), or if you already have an account, then sign in.
+3. Click on the pen icon to fork the repo so you can start contributing to the documentation.
+  ![fork-repo](https://user-images.githubusercontent.com/55744578/136702921-3105350a-a68a-4aa4-8c5d-fb24742652b2.jpg)
+4. Edit MD files:
+  - We use markdown in the documentation, you will need to know markdown to be able to contribute to the docs.
+  - Make edits to the files after forking the repo and preview your changes. If you have not read our [content style guide](https://www.notion.so/matterlabs/Communication-Strategy-a4836bd6d2254268b60a489d82992d71), please do before you begin this step.
+5. Write a brief description of the changes you made and click on `Propose Changes`. 
+6. After editing the files click on `Create pull request` and wait for our reviewers to review your PR.
+  ![create-pull-request](https://user-images.githubusercontent.com/55744578/136703597-6644e43c-7c64-4cc0-bf8b-7fb8db9544cf.jpg)
+
+
+### Learning/Improvement resources: 
+
+- [Technical Writing Best Practices](https://proedit.com/technical-writing-best-practices/).
+- [9 Technical Writing Tips Every Writer Needs to Know](https://www.instructionalsolutions.com/blog/technical-writing-tips).