Merge pull request #12 from sailpoint-oss/feature/new-docs-structure

Feature/new docs structure
This commit is contained in:
Philip Ellis
2022-09-01 16:55:58 -04:00
committed by GitHub
231 changed files with 1753 additions and 1110 deletions

View File

@@ -6,26 +6,18 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Developer Community',
tagline: 'Developers are cool',
title: 'SailPoint Developer Community',
url: 'https://developer.sailpoint.com',
baseUrl: '/',
favicon: 'img/SailPoint-Logo-Icon.ico',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'SailPoint', // Usually your GitHub org/user name.
projectName: 'SailPoint Developer Community', // Usually your repo name.
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
onDuplicateRoutes: 'warn',
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
@@ -53,8 +45,12 @@ const config = {
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true,
}
autoCollapseCategories: false,
},
},
colorMode: {
defaultMode: "light",
respectPrefersColorScheme: true
},
navbar: {
title: '',
@@ -64,144 +60,159 @@ const config = {
srcDark: 'img/SailPoint-Developer-Community-Inverse-Lockup.png'
},
items: [
{
type: 'dropdown',
label: 'Learn',
position: 'right',
items: [
{
href: 'https://medium.com/sailpointtechblog',
label: 'Engineering Blog',
},
{
href: 'https://community.sailpoint.com/t5/Professional-Certification/ct-p/product-certification-program',
label: 'Certifications',
},
// ... more items
],
},
{
type: 'dropdown',
label: 'IdentityNow',
position: 'right',
position: 'left',
items: [
{to: '/docs/category/identity-now-api-v3', label: 'V3 APIs'},
{to: '/docs/category/identity-now-api-beta', label: 'Beta APIs'},
{
type: 'doc',
docId: 'idn_docs/intro',
label: 'Documentation',
},
// ... more items
{to: "#", label: "API Specifications", className: "section__docs",},
{to: '/idn/api/v3', label: 'V3 APIs', className: "indent"},
{to: '/idn/api/beta', label: 'Beta APIs', className: "indent"},
{to: "#", label: "Documentation", className: "section__docs",},
{to: '/idn/docs/getting-started', label: 'IDN Documentation', className: "indent"}
],
},
{
type: 'dropdown',
label: 'IdentityIQ',
position: 'right',
position: 'left',
items: [
{to: '/docs/category/iiq-api', label: 'APIs'},
{
type: 'doc',
docId: 'idn_docs/intro',
label: 'Documentation',
},
// ... more items
{to: "#", label: "API Specifications", className: "section__docs",},
{to: '/iiq/api', label: 'IIQ APIs', className: "indent"}
],
},
{
type: 'dropdown',
label: 'ARM',
position: 'right',
items: [
{to: '/docs/category/arm-agent-management', label: 'ARM APIs'}
],
position: "left",
label: "Ideas",
to: "https://developer-sailpoint.ideas.aha.io/"
},
{
type: 'dropdown',
label: 'Tools',
position: 'right',
items: [
{
href: 'https://github.com/sailpoint-oss',
label: 'GitHub',
},
// ... more items
],
position: "left",
label: "Discuss",
to: "https://developer.sailpoint.com/discuss"
},
{
type: 'dropdown',
label: 'Community',
position: 'right',
type: "dropdown",
label: "Support",
position: "right",
items: [
{
href: 'https://developer.sailpoint.com/discuss',
label: 'Discuss',
},
{
href: 'https://developer-sailpoint.ideas.aha.io/',
label: 'Ideas',
},
{
href: 'https://community.sailpoint.com/',
label: 'Compass',
},
// ... more items
],
{label: "Compass", href: "https://community.sailpoint.com"},
{label: "Submit Support Ticket", href: "https://support.sailpoint.com"}
]
},
{
type: 'dropdown',
label: 'Support',
position: 'right',
items: [
{
href: 'https://support.sailpoint.com/hc/en-us',
label: 'Customer Support',
},
// ... more items
],
position: "right",
to: "https://github.com/sailpoint-oss",
className: "header-github-link",
"aria-label": "SailPoint Open-source GitHub"
},
],
{
href: "https://medium.com/sailpointtechblog",
className: "header-blog-link",
position: "right",
"aria-label": "SailPoint Engineering Blog",
},
]
},
footer: {
style: 'dark',
style: "light",
links: [
{
title: 'Docs',
title: "IdentityNow",
items: [
{
label: 'Tutorial',
to: '/docs/intro',
label: "Make Your First API Call",
to: "idn/docs/getting-started"
},
],
{
label: "Build A Transform",
to: "idn/docs/transforms"
},
{
label: "Build A SaaS Connector",
to: "idn/docs/saas-connectors"
},
]
},
{
title: 'Community',
title: "IdentityIQ",
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
},
],
label: "Build An IdentityIQ Plugin",
to: "https://documentation.sailpoint.com/"
}
]
},
{
title: 'More',
title: "Community",
items: [
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
label: "Discuss",
to: "https://developer.sailpoint.com/discuss"
},
],
{
label: "Submit an Idea",
to: "https://developer-sailpoint.ideas.aha.io/"
},
{
label: "Contact the DevRel Team",
to: "mailto:developers@sailpoint.com"
}
]
},
{
title: "More",
items: [
{
label: "Engineering Blog",
href: "https://medium.com/sailpointtechblog"
},
{
label: "GitHub",
href: "https://github.com/sailpoint-oss"
},
{
label: "Twitter",
href: "https://twitter.com/sailpoint"
},
]
},
{
title: "Company",
items: [
{
label: "The SailPoint Story",
to: "https://www.sailpoint.com/company/"
},
{
label: "The SailPoint Way",
to: "https://www.sailpoint.com/company/diversity-inclusion-and-belonging/"
},
{
label: "Leadership Team",
to: "https://www.sailpoint.com/company/#h-our-leadership"
},
{
label: "Become A Partner",
to: "https://www.sailpoint.com/partners/become-partner/"
}
]
},
{
title: "Legal",
items: [
{
label: "Terms & Conditions",
to: "https://developet.sailpoint.com"
}
]
}
],
logo: {
alt: 'SailPoint Developer Community Logo',
src: '/img/SailPoint-Developer-Community-Lockup.png',
href: 'https://developer.sailpoint.com',
},
copyright: `Copyright © ${new Date().getFullYear()} SailPoint Technologies Holdings, Inc. All Rights Reserved.`,
},
prism: {
@@ -211,15 +222,34 @@ const config = {
}),
plugins: [
[
"@docusaurus/plugin-content-docs",
{
id: "idn",
path: "products/idn",
routeBasePath: "idn",
sidebarPath: require.resolve("./products/idn/sidebar.js"),
},
],
[
"@docusaurus/plugin-content-docs",
{
id: "iiq",
path: "products/iiq",
routeBasePath: "iiq",
sidebarPath: require.resolve("./products/iiq/sidebar.js"),
},
],
[
"docusaurus-plugin-openapi-docs",
{
id: "openapi",
docsPluginId: "classic",
id: "idn",
docsPluginId: "idn",
config: {
idn_v3: {
specPath: "static/idn-api/sailpoint-api.v3.yaml",
outputDir: "docs/idn/sailpoint-api-v3",
outputDir: "products/idn/api/v3",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
@@ -227,124 +257,29 @@ const config = {
},
idn_beta: {
specPath: "static/idn-api/sailpoint-api.beta.yaml",
outputDir: "docs/idn/sailpoint-api-beta",
outputDir: "products/idn/api/beta",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
}
}
],
[
"docusaurus-plugin-openapi-docs",
{
id: "iiq",
docsPluginId: "iiq",
config: {
iiq: {
specPath: "static/iiq-api/swagger.json",
outputDir: "docs/iiq/iiq-api",
outputDir: "products/iiq/api",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_agent_management: {
specPath: "static/arm-api/swagger-agent-management.json",
outputDir: "docs/arm/swagger-agent-management",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_analysis: {
specPath: "static/arm-api/swagger-analysis.json",
outputDir: "docs/arm/swagger-analysis",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_arm: {
specPath: "static/arm-api/swagger-arm.json",
outputDir: "docs/arm/swagger-arm",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_arm2: {
specPath: "static/arm-api/swagger-arm2.json",
outputDir: "docs/arm/swagger-arm2",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_authentication: {
specPath: "static/arm-api/swagger-authentication.json",
outputDir: "docs/arm/swagger-authentication",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_cloud_agent: {
specPath: "static/arm-api/swagger-cloud-agent.json",
outputDir: "docs/arm/swagger-cloud-agent",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_jobs: {
specPath: "static/arm-api/swagger-jobs.json",
outputDir: "docs/arm/swagger-jobs",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_logging: {
specPath: "static/arm-api/swagger-logging.json",
outputDir: "docs/arm/swagger-logging",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_provisioning: {
specPath: "static/arm-api/swagger-provisioning.json",
outputDir: "docs/arm/swagger-provisioning",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_public: {
specPath: "static/arm-api/swagger-public.json",
outputDir: "docs/arm/swagger-public",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_rulebook: {
specPath: "static/arm-api/swagger-rulebook.json",
outputDir: "docs/arm/swagger-rulebook",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_scheduling: {
specPath: "static/arm-api/swagger-scheduling.json",
outputDir: "docs/arm/swagger-scheduling",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
arm_utilization_tracking: {
specPath: "static/arm-api/swagger-utilization-tracking.json",
outputDir: "docs/arm/swagger-utilization-tracking",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
}
}
}
]