palisadoesfoundation / talawa-docs Goto Github PK

Links to CONTRIBUTING.md and Talawa-Docs GitHub repo are broken

Upgrade to latest version of Docusaurus: 2.0.0-beta.9

Remove references to Docusaurus v1.X in repo

Fix Dependabot security vulnerablities

Our current logos do not have Talawa text. This creates some issues:

1. It is difficult to define our typography when the Talawa text is used beside the logo.
2. It makes it difficult to have a consistent user experience when using our various web and mobile apps.

We need additional logo files with proportionately sized text:

1. Beside and to the right of the logo
2. Centered and below the logo

Other guidance

1. The new files must use the existing ones as the starting template
2. The new files with text must have the same names as the existing files, but with the suffix text with-text-vertical and with-text-horizontal added before the filename extension.

Some other factors to consider:

1. The text must not dominate the logo.
2. These logos must be added to the logo repository directory.
3. Use our Typography Guidelines found in the branding section of our documentation

Note: Please use the GitHub issue auto closing feature when working on this issue.

We need better consistency in the quality of our documentation. The current style guide only focuses on the technical details of how to create documents, and not on the general formatting of documentation. This needs to be greatly improved.

There are many open source projects that have style guides that we could use as a starting point. Here is an example:

• https://flink.apache.org/contributing/docs-style.html

The resulting document needs to be added to the repo and a link for it included in the Talawa documentation introduction

Fix bad links in GSoC introduction page

Description: As we have the new set of logos, we need to have some clear rules defining the usage of them in different situations.
Solution: Update documentation regarding the Assets, things need to be accomplished,

• - Logos - PR #34
• - Color Palette
• - Typography
• - Patterns & Illustrations

Are You Willing to Work on This: Yes :)

Using Pagination and clickable docs for the talawa-docs.

A new process has been created.

Description: Algolia was used in the Docusaurus itself, and this can be implemented with the Talawa Docs as Algolia is free for Open Source Projects
https://www.algolia.com/for-open-source/

Add sample code of existing API's mutations & queries on Talawa-API Section

1. This will help reduce the risk of future vulnerabilities
2. Follow the procedure here

As the whole codebase of Talawa-Admin has been changed from vue js to react js there is a need to update the Talawa-Admin part of docs so that contributors can get a clear idea about the technologies used in the project @palisadoes sir

The styling for the docs need to be improved from the default theme, this could just be a colour change and to modify the default placeholders on the homepage.

NOTE: This issue is linked to one in the Talawa-API repo

The Legacy Talawa-API documentation website needs to be migrated to the new Talawa Docs website

The steps to do this would be:

1. Create a major heading for Talawa-API in the Talawa-Docs repo
2. Migrate the existing Talawa-API documents in the talawa-api repo to the Talawa-Docs repo. Note: The source documents are in RST format and will need to be converted to .MD format.
3. Inform @palisadoes when the pull request for this documentation is completed so that the legacy ReadTheDocs site can be removed.

Copy / pasting the documentation will not be enough. The documentation has changed. You will need to update the documentation so that it matches the current master branch functionality.

Remove all references to Version: 2.0.0-beta.6 We are now at Version: 2.0.0-beta.9

Based on the information at http://www.palisadoes.org/gsoc/

Existing Talawa repos have detailed CONTRIBUTING.md files. This documentation repo doesn't. We need to create a clear set of rules and guides on how to become an effective collaborator on the project.

I want to contribute in this plz assign me some work where i can contribute

Description: As we have a new logo for the project, we would also need vector files in the below mentioned format for different purposes.
File Types Required:

• - .pdf
• - .ai
• - .svg
• - .eps

Are You Willing to Work on this: Yes

We need better documentation on how to create good documentation for the project.

The README.md file has many issues that need to be rectified:

1. There is no description of the Palisadoes Foundation
2. There is no description of the various Talawa projects
3. There are no detailed explanations of how to configure your system to work with the Docusaurus model
4. There isn't a reference to Contributing.md nor the style guide document
5. There isn't a reference on how to add new pages and integrate your changes into our Docusaurus system

I can create a good logo/icon for the Talawa Docs and my idea was to use the existing Talawa Icon and add some letter or document symbol to it to make it look even better and thus would relate to the Main Talawa App itself

Will give the Vector files also :)

Add the introduction to Talawa and GSoC to the Talawa documentation. Source from: http://www.palisadoes.org/gsoc/

multisite written as mulitsite and many other are there @jordanliu can you please assign me this

Add Page with Link to Test Environment Server

While exploring about talawa, I went through the documentation and came across few errors that needs to be resolved for better documentation.

@palisadoes
Can I work on this issue ?

Fix broken logo on documents page due to renaming of logos folder

Description: The logos and icons used currently have a white background, which does not look good in dark theme
Screenshots:

• The below image is in Dark Mode
  

• The below image is in Light Mode
  

• The Favicon
  

Solution: Use transparent PNG Images for the icons as well as logos :)
Are You Willing to work on this: Yes

We're now using a centralized repository containing documentation for both repos. As a result, we'll be needing to migrate the docs that are in talawa which is rst to markdown

https://github.com/PalisadoesFoundation/talawa/tree/master/docs

Based on: http://www.palisadoes.org/gsoc/

We are migrating GSoC related documentation to the Talawa docs repo for ease of management.

It would be beneficial for new contributor if We add How to guide to install & run talawa-api locally

Description: A Travis CI action can be implemented to the project so as to make it easier for checking of conflicts, and run integrated tests. It can be used for Deployment also

I guess this has to be added by the maintainers itself 😶

General guidelines:

1. The logo assets must be moved to the other logos directory
2. The wording of the page needs to be simplified.

Add page with reference to our logos

Description: The different links to Social Media of the organization aren't linked
Screenshot:

CVE-2021-23436
Moderate severity

1. Vulnerable versions: < 9.0.6
2. Patched version: 9.0.6

This affects the package immer before 9.0.6. A type confusion vulnerability can lead to a bypass of CVE-2020-28477 when the user-provided keys used in the path parameter are arrays. In particular, this bypass is possible because the condition (p === "proto" || p === "constructor") in applyPatches_ returns false if p is ['proto'] (or ['constructor']). The === operator (strict equality operator) returns false if the operands have different type.

Remediation
Upgrade immer to version 9.0.6 or later.

Screenshots

There are few spelling mistakes in the documentation. For eg: "administrator " is misspelled as "adminis trator", etc.

@palisadoes could you please assign this issue to me?

Move the timeline data found at: http://www.palisadoes.org/gsoc/

Putting compulsory Pipette score of 70% to create the clean and systematic code. And Write the Documentation for the same.

I can work on to create new illustrations for different aspects of the Talawa Docs Page to make it more visually appealing :)

Include separate sections on:

1. Typography
2. Color palette