Skip to content

Update Publish page #158

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

Merged
merged 3 commits into from
Nov 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 38 additions & 48 deletions docs/core-concepts/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,71 +2,61 @@
title: Publish
---

# Publish project
# Publish your Projects

Any project you build in Plane can be turned into a public page, creating a fully navigable website. This feature will make it easier for your users and customers know what features you’re on or when bug fixes are rolling out. No sign-up's required.
Any project you build in Plane can be turned into a public page, creating a fully navigable website. This makes it easy for your users and customers to see your latest features or when bug fixes roll out—no sign-up required.

## How to deploy your Plane project
## How to publish project

Any project on Plane can be made public with Plane Deploy with just few clicks. Note that this feature can be only accessed by Admins or Owners of a certain workspace. Following are the steps to deploy a project in Plane.
Only Admins can publish a project in Plane. Here’s how:

* Open the Plane workspace and navigate to the specific project you aim to deploy.
* Locate the ellipsis (`...`) icon adjacent to the project name. Click on this icon to reveal the project settings menu.
* From the dropdown menu, select the `Publish` option. This action will trigger a modal dialog window.
* In the displayed modal window, you will find various options to configure your public board settings.
* After finalizing your settings, click the `Publish` button. You will be immediately redirected to your newly created public board.
1. Open your Plane workspace and navigate to the project you want to publish.
2. Click on the ellipsis **...** icon next to the project name to access the project settings menu.
3. Select **Publish** from the dropdown menu, which will open a modal dialog.
4. Configure your public board options in this modal.
5. Once ready, click **Publish**. You'll be instantly redirected to your new public board.

## Plane Deploy Features
## Publish features

### Plane Deploy Layouts
### Layout options

You can deploy your projects in two layouts: **`Kanban`** and **`List`**. If you want to allow others to view your project boards in both layouts, you can enable them. If your projects have a specific focus, choose the layout that suits you best.
You can publish your project in either **Kanban** or **List** layouts. Choose whichever view best fits your project, or enable both to give viewers more flexibility. Soon, Gantt and Spreadsheet layouts will also be available.

Soon Plane Deploy supports Gantt and Spreadsheet layouts as well.
#### Attribute privacy

## Attribute Privacy
**Visible attributes**

Visible Attributes
* Project name
* Project issues
* Issue ID
* Title
* Description
* State, due-date, priority
* Comments
* Reactions + `user_names` of users who reacted
* Upvotes and downvotes + `user_names` of users who voted

* Project Name
* Project Issues
* Issue ID
* Issue Title
* Issue Description
* Issue State, Due-date, Priority
* Issue Comments (Public Comments ✅ | Private Comments 🚫)
* Issue Reactions + `user_names` of reacted users
* Issue Upvote and Downvote + `user_names` of reacted users
**Non-visible attributes**

Non-Visible Attributes
* Attachments
* Issue links
* Relations
* Cycles
* Modules
* Project settings
* Members

* Private Comments
* Project Attachments
* Issue Links
* Issue Props - Blocking, Blocked\_by
* Project Cycles
* Project Modules
* Project Settings
* Project Members
### Commenting options

### User Commenting
When enabled, users can sign up on the public board and add comments to issues—ideal for gathering feedback and showing progress.

When enabled before deployment, users can sign up on the public board and add comments to issues. This feature is useful for collecting feedback and tracking progress.

Project members can comment in either public or private mode. Private comments are visible only to project members, while public comments can be viewed on both internal and public boards.

### Upvotes and Downvotes
### Upvotes and downvotes

When enabled, users can upvote or downvote any issue on the deployed board. This helps project managers or owners prioritize which issues need attention.

### Issue Reactions

When this feature is enabled, users can react to issues on the public board using predefined emoticons. This provides a quick way for team members and the public to express their sentiments about specific issues, aiding in gauging overall opinion and urgency.

### Public Commenting and Private Commenting

This feature allows for both public and private comments on issues. Public comments can be seen by anyone who has access to the public board, offering a transparent way to gather community input. Private comments, on the other hand, are only visible to project members, allowing for internal discussions that are not disclosed to the public.
### Issue reactions

### Free Domain
When this feature is on, users can react to issues on the public board using predefined emoticons. This provides a quick way for team members and the public to express their sentiments about specific issues, aiding in gauging overall opinion and urgency.

Plane Deploy provides an option to host your public board on a free domain. This makes it even more accessible and straightforward for your audience to engage with your project. No additional setup or domain registration is required; simply choose this option during the publishing process, and your public board will be instantly accessible via the free domain.
### Free domain hosting
You can host your public board on a free domain, making it simple and accessible for anyone to check out your project. No additional setup or domain registration is required; simply choose this option during the publishing process, and your public board will be instantly accessible via the free domain.