Permission for KB Guide

Note

KB Guides are enabled by default in Communities Aurora v24.07 and above for all the communities which use Knowledge Bases.
Contact Support to enable the KB Guides config.

Community members who have the Create, edit, publish, and manage articles permission can create and manage KB Guides.

Community members who don't have this permission can only view the contents of the guides.

Contact your community Administrators to assign this permission.

Fetch the Guide Settings

Use the GraphQL query to determine whether the feature is enabled for your community.

query {
  community {
    knowledgeBaseSettings {
      isGuidesAndChaptersEnabled {
        key
        value
      }
    }
    knowledgeBaseProperties {
      isGuidesAndChaptersEnabled
    }
  }
}

GraphQL response:

{
    "data": {
        "community": {
            "knowledgeBaseSettings": {
                "isGuidesAndChaptersEnabled": {
                    "key": "config.enable_kb_guides_and_chapters",
                    "value": true
                }
            },
            "knowledgeBaseProperties": {
                "isGuidesAndChaptersEnabled": false
            }
        }
    }
}

Enable KB Guide Setting for Community

Note

Only Administrators can turn on or off the KB guides feature.

To enable the KB Guides feature, use the setKnowledgeBaseSettingsOnCommunity mutation.

mutation {   
  setKnowledgeBaseSettingsOnCommunity(
    settingsInput:{
      isGuidesAndChaptersEnabled: true
    }) 
  {
    result
  }
}

GraphQL response:

{
    "data": {
        "setKnowledgeBaseSettingsOnCommunity": {
            "result": true
        }
    }
}