Setting or Updating the Name in Your Profile
Can I Schedule a Demo?
The HelpDocs Trial
Setting Up a Custom Domain
Setting the URL Style for your Articles
Switching Between Multiple Accounts
Adding or Changing Your Profile Image
Logging In To Your HelpDocs
Understanding Smart 404 Pages
Understanding Top Articles
Writing and Editing Articles
Adding an HTML Block
Using Markdown Blocks
Using Code Blocks
Getting Started with Content Blocks
Using Quote Blocks
Understanding Article Statuses
Article Backups, Revisions, and Versioning
Text Editor Shortcuts
Adding Tags to Articles
Using Ordered Lists
Moving an Article to a Different Category
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Switching the Editor Mode
Understanding Search Results
Duplicating an Article
Incompatible Browser Extensions
Downloading Articles to PDF
Deleting an Article
What is Readability?
Collaborating on Articles with Presence
Adding a Table of Contents
Restoring Deleted Articles
Editing Category Metadata
Exporting & Backing Up Your Articles
Hiding Articles from Public Search Engines
Delete a Category
Featuring an Article
Creating Draft Versions of Published Articles with Working Copy
Bulk Select & Edit Multiple Articles
Creating a Subcategory
Linking to a Part of an Article
Using help.new to Create Articles
Setting Up Integrations
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
Installing the Slack Integration
Sharing Articles From HelpDocs to Slack
Configuring Your Slack Integration
Connecting Google Analytics
Adding a Feedier Carrier
Connecting Gainsight PX
Using HelpDocs with Ticketing Systems
Syncing Content to elevio
Enabling Comments with Disqus
Connecting Sunshine Conversations
Customizing your HelpDocs
Condense Top Article Spacing on Bars V4
Adding Lightboxes to Images
Overriding the Font on Your Knowledge Base
Making Your Printed HelpDocs Look Nicer
Making Video Embeds Responsive
Disabling Authorship and Updated Times
Getting Help with Code Snippets
Disabling Top Articles
Using Different List Styles
Using HelpDocs with RTL Languages
Disabling Related Articles
Using a Background Image in the Header
Making Tables Scroll When They're Too Wide for the Page
How to Change the Logo Link
How to Add Extra Spacing
Add HTML Before the Closing Body Tag
Customizing Feedback Icons
Custom HTML Templates
Understanding the Contact Form
Changing the Language in Common Phrases
Hiding the Contact Button
Customizing an Article Slug, Meta Description & Short Version
Adding Custom CSS
Setting Article Display Order
Adding Custom Navigation Links
Setting a Custom Favicon
Setting Category Display Order
Uploading Your Brand Logo
Adding URL Redirects
Featuring a Category
Adding Icons to Categories
Hosting HelpDocs at a Subfolder of Your Site
Adding an Open Graph Fallback Image
Choosing a Template
Testing Customizations with .dev
Adding Cookie Consent
Understanding Machine Translation Credits
Customizing How Machine Translations Work
Automatically Translate Articles with Machine Translations
Setting Up Multilingual
Understanding Multilingual Translation
Creating a Read-Only Permission Group for Public Articles
Creating and Managing Permission Groups
Getting Started with Permissioning
Assigning Permission Groups to Categories
Assigning Permission Groups to Articles
Removing Permission Groups from Articles
Setting Up Two-Factor Authentication
Setting Up and Using SAML Single Sign-On
Restricting your HelpDocs with Custom JWT SSO
Using OpenID Connect for Single Sign On
Configuring Slack Single Sign On
Restricting Your Docs to Logged In Users
Shared Password Protection
Accessing User Data in HelpDocs
Data & Analytics
Getting Team Event History with Audit Trail
Understanding Articles Clicked
What are Tickets Avoided?
Exporting Your Stats
What is the Happiness Score?
Lighthouse Widget API
Integrating Lighthouse with Live Chat Providers
Adding Lighthouse Trigger Buttons to Webflow
Cancelling Your Account
Downloading Invoices and Receipts
Updating Your Billing Information
Changing Your Plan
Subscribing to a Plan for the First Time
European Union VAT Charges
Tax Residency Certificates and Forms
I can't log in to my HelpDocs account or complete signup
How do I reset my password?
How do I change my email?
Can I use multiple HelpDocs accounts together?
Can I migrate or import my data from another service?
Who counts towards the user limit on plans?
Can I Change the HelpDocs Branding?
Can I have a single article appear in multiple categories?
Can I host my internal docs in HelpDocs?
I’m seeing a blank screen when I load my knowledge base
Help! No articles are appearing on my knowledge base
What is an account slug?
I've added a script but it isn't working
Help! My app's not loading 😭
Can I embed files into HelpDocs?
How do related articles work?
Can I host my API docs in HelpDocs?
Will translated articles be deleted if I remove that language?
My Article Has a Blank Space to the Left. What's Wrong?
One of my headings isn't showing in the table of contents
I'm getting 'Your connection is not private' on my custom domain
HelpDocs Support Scope
How do I publish an article that's not available in the default language?
Why isn't my contact form showing up?
Optimizing Your Knowledge Base for Search
Creating a Knowledge Base from Scratch
Finding CSS Selectors in Your Browser
Clearing the Cache in Your Browser
Writing Clear and Digestible Knowledge Base Articles
Security & Compliance
Table of Contents
- Knowledge Base
- Getting Started with Permissioning
Getting Started with Permissioning
Updated by Taylor Sloane
Looking to restrict certain docs to certain users? This is exactly what Permissioning helps you do. By restricting articles or whole categories you can choose who sees what.
This means you can host different articles for different people within the same knowledge base and can easily manage access at an article-by-article level.
By default all published articles are available for the public to view. With Permissioning you can restrict who can see certain articles or articles within a category.
Whenever you're working with Permissions you'll see the Permissions icon which looks like this:
Traits You Can Use to Restrict Access
To make Permissioning super flexible you can restrict access by three different types of trait. You can get specific and restrict down to certain users or broad and restrict to entire roles.
- 🏃♀️🏃🏃♂️ Groups. Allow access to an entire group of users
- 🎒 Roles. Allow access to an entire role like Editors
You'll always be able to see exactly who has access under the Members with Access divider.
Example Use Cases
So why might you wanna separate content out? Here's some examples we've seen of Permissioning being used in the wild 🦁
📕 Internal Whole Team Content
You've got a team who refer to your knowledge base everyday for customer support. Why not create an internal category to house all your internal authoritative information? Things like company processes, style guides, and feature plans.
User group: Team HelpDocs
📢 Internal Marketing Content
Got a larger company? You could segment things like blog style guides and analytics process documentation so only marketing can see them.
Category: Internal Marketing
User group: HelpDocs Marketing
🔗 Integration Partners
Want other companies to work on marketing or development to create partnerships with your team? You can create a whole category so only partners can see your partner processes.
User group: Partners
Setting up Permissions for the First Time
- Start by creating a new user group
- Assign that user group to a user
- Apply that group to an article
Does an Article Have Permissions?
So you've set Permissioning on an article but how can you and your team tell if it has Permissions? There are a few places we show whether it does or not.
Inside the Article Editor
When you're editing an article that has permissions you'll see an icon in the top right of the toolbar with a pink dot next to it. If you're hovering over it you'll see Edit Permissions as a tooltip.
In the Content View
If you're browsing articles within the content view you'll be able to tell if it's Permissioned in a few ways.
- You'll see it next to the article meta like the published status
- You'll be able to see it to the right with the permissioning button. If it has permissions it'll appear with a pink icon just like inside the text editor