-
-
Notifications
You must be signed in to change notification settings - Fork 811
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactoring CSS files: merged PageNotFound styles into global app.module.css #2697
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"singleQuote": true, | ||
"endOfLine": "auto" | ||
} | ||
"singleQuote": true, | ||
"endOfLine": "auto" | ||
} |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,4 +1,5 @@ | ||||||
# Documentation | ||||||
|
||||||
Welcome to our documentation guide. Here are some useful tips you need to know! | ||||||
|
||||||
# Table of Contents | ||||||
|
@@ -15,18 +16,21 @@ Welcome to our documentation guide. Here are some useful tips you need to know! | |||||
|
||||||
Our documentation can be found in ONLY TWO PLACES: | ||||||
|
||||||
1. ***Inline within the repository's code files***: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/). | ||||||
1. ***In our `talawa-docs` repository***: Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package. | ||||||
1. **_Inline within the repository's code files_**: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/). | ||||||
1. **_In our `talawa-docs` repository_**: Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package. | ||||||
|
||||||
## How to use Docusaurus | ||||||
|
||||||
The process in easy: | ||||||
|
||||||
1. Install `talawa-docs` on your system | ||||||
1. Launch docusaurus on your system according to the `talawa-docs`documentation. | ||||||
- A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/ | ||||||
1. Launch docusaurus on your system according to the `talawa-docs`documentation. | ||||||
- A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/ | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix grammar in the documentation The sentence has incorrect verb form. -A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/
+A local version of `docs.talawa.io` should automatically launch in your browser at http://localhost:3000/ 📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~28-~28: The modal verb ‘should’ requires the verb’s base form. (MD_BASEFORM) 🪛 Markdownlint (0.37.0)28-28: null (MD034, no-bare-urls) |
||||||
1. Add/modify the markdown documents to the `docs/` directory of the `talawa-docs` repository | ||||||
1. If adding a file, then you will also need to edit the `sidebars.js` which is used to generate the [docs.talawa.io](https://docs.talawa.io/) menus. | ||||||
1. Always monitor the local website in your brower to make sure the changes are acceptable. | ||||||
- You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website. | ||||||
1. Always monitor the local website in your brower to make sure the changes are acceptable. | ||||||
- You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website. | ||||||
|
||||||
## Other information | ||||||
***PLEASE*** do not add markdown files in this repository. Add them to `talawa-docs`! | ||||||
|
||||||
**_PLEASE_** do not add markdown files in this repository. Add them to `talawa-docs`! |
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -4,7 +4,8 @@ | |||||||||||
|
||||||||||||
In order to give everyone a chance to submit a issues reports and contribute to the Talawa project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in the Talawa project. | ||||||||||||
|
||||||||||||
___ | ||||||||||||
--- | ||||||||||||
|
||||||||||||
## Table of Contents | ||||||||||||
|
||||||||||||
<!-- toc --> | ||||||||||||
|
@@ -18,15 +19,17 @@ ___ | |||||||||||
|
||||||||||||
<!-- tocstop --> | ||||||||||||
|
||||||||||||
___ | ||||||||||||
--- | ||||||||||||
|
||||||||||||
## Issue Management | ||||||||||||
|
||||||||||||
In all cases please use the [GitHub open issue search](https://github.com/PalisadoesFoundation/talawa-admin/issues) to check whether the issue has already been reported. | ||||||||||||
|
||||||||||||
### New Issues | ||||||||||||
|
||||||||||||
To create new issues follow these steps: | ||||||||||||
|
||||||||||||
1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created. | ||||||||||||
1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created. | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix the grammatical errors in the duplicate issue search guidance. The current sentence has concatenation errors and unclear wording. -1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created.
+1. Your issue may have already been created. Search for duplicate open issues before submitting yours to avoid redundancy. 📝 Committable suggestion
Suggested change
|
||||||||||||
1. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository. | ||||||||||||
1. Click on the [`New Issue`](https://github.com/PalisadoesFoundation/talawa-admin/issues/new/choose) button | ||||||||||||
1. Use the templates to create a standardized report of what needs to be done and why. | ||||||||||||
|
@@ -49,11 +52,12 @@ Working on these types of existing issues is a good way of getting started with | |||||||||||
|
||||||||||||
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible. | ||||||||||||
|
||||||||||||
### Monitoring the Creation of New Issues | ||||||||||||
### Monitoring the Creation of New Issues | ||||||||||||
|
||||||||||||
1. Join our `#talawa-github` slack channel for automatic issue and pull request updates. | ||||||||||||
|
||||||||||||
## General Guidelines | ||||||||||||
|
||||||||||||
1. Discuss issues in our various slack channels when necessary | ||||||||||||
2. Please do not derail or troll issues. | ||||||||||||
2. Please do not derail or troll issues. | ||||||||||||
Comment on lines
61
to
+62
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Fix capitalization and punctuation.
-1. Discuss issues in our various slack channels when necessary
+1. Discuss issues in our various Slack channels when necessary, 📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~61-~61: Did you mean the communication tool “Slack” (= proper noun, capitalized)? (ON_SKYPE) [typographical] ~61-~61: Consider adding a comma here. (PLEASE_COMMA) |
||||||||||||
3. Keep the discussion on topic and respect the opinions of others. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add language specification to the code block.
Add HTML/CSS language identifier to enable syntax highlighting for better readability.
🧰 Tools
🪛 Markdownlint (0.37.0)
64-64: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
58-58: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)