Giter VIP home page Giter VIP logo

docs's Introduction

Plane Documentation

Welcome to the documentation repository for Plane! This repository hosts comprehensive documentation for Plane, accessible at docs.plane.so.

Overview

The Plane documentation provides detailed information on the following topics:

  • Setting up and managing a self-hosted instance of Plane.
  • Understanding the different components of Plane.
  • Establishing connections between Plane and other applications.

Raising Issues

If you encounter any issues with our documentation or have suggestions for improvements, we encourage you to follow these steps:

  1. Check Existing Issues: Before raising a new issue, please verify if a similar issue already exists.
  2. Raise an Issue: If you don't find an existing issue that matches your concern, feel free to create a new one. Provide as much detail as possible to clearly explain the problem or enhancement you're proposing.

Contributing

Are you interested in contributing to our documentation? We welcome contributions from the community! You can contribute by:

  • Fixing bugs in the existing documentation.
  • Adding new guides or tutorials.

To get started with contributing, please refer to our Contribution Guide. We appreciate contributions related to self-hosting, core product functionality, and integrations with other applications.

Thank you for considering contributing to Plane documentation. Your contributions help improve the overall user experience and make information more accessible to all users. Let's work together to make Plane documentation even better!

docs's People

Contributors

dilippitchika avatar goetzk avatar gurusainath avatar pablohashescobar avatar prateekshourya29 avatar primeagen-rustaceans avatar quadrubo avatar rameshkumarchandra avatar samuel-hoskin avatar srinivaspendem avatar sriramveeraghanta avatar sudovanilla avatar tmchein avatar vihar avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

docs's Issues

Different Discord invites on different pages

I am asking this question, and possibly proposing a change:

There are different Discord invite links on different pages, for example
one in the end of Get Started doesn't match with the one in the footer.
Are they supposed to be like so or is it just a mistake?

Potential solution

Make a redirect like discord.plane.so, that would lead to one Discord invite link, and make every other page link to it.

Pros

  • easier to manage: if there are issues with one link, just change it to another one
  • easier to access: someone could link to discord.plane.so and not have to worry about the link being possibly wrong
  • removes the possibility of typos (i.e. someone accidentally left out one character)

Cons

  • having to rewrite all links to the redirect

chore request: add grammar checker to the ci workflow

this issue is a feature request, solving which will not affect the production nor affect the ui/ux (because of that it would be in the chore category), for the addition of a grammar checker (via github actions) to eliminate typos and misspellings.

this will positively affect the ui & the ux in the sense of less possibility of a user misunderstanding the documentation in some way.

i will follow up with a possible solution and maybe will submit a pr containing the solution for this issue.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.