mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
Consolidate shared ux team dev docs (#172966)
## Summary
This PR consolidates shared ux team dev docs similar how it was done by
operations team.
There is a separate "Shared UX" toc in the nav with the team's
catalogue. Also a landing page with our catalog.
<img width="1185" alt="Screenshot 2023-12-08 at 17 01 15"
src="c8e758f0
-bcaa-4c74-9187-2911b2e7a680">
This commit is contained in:
parent
134012be32
commit
92c7288816
4 changed files with 151 additions and 27 deletions
70
dev_docs/shared_ux/shared_ux_landing.mdx
Normal file
70
dev_docs/shared_ux/shared_ux_landing.mdx
Normal file
|
@ -0,0 +1,70 @@
|
|||
---
|
||||
id: kibDevDocsSharedUxOverview
|
||||
slug: /kibana-dev-docs/shared-ux
|
||||
title: Shared UX Team
|
||||
description: Links to all the documentation maintained by the Shared UX team.
|
||||
tags: ['kibana', 'dev', 'shared-ux']
|
||||
layout: landing
|
||||
---
|
||||
|
||||
<DocLandingHero
|
||||
title="Welcome to Shared UX team docs!"
|
||||
description="👋 Here you will find documentation about all the things the Shared UX team manages. Feel free to look around and ask questions!"
|
||||
/>
|
||||
|
||||
<DocRelatedArticles
|
||||
sectionTitle="About the team"
|
||||
items={[
|
||||
{
|
||||
title: 'Team Wiki',
|
||||
description: 'Learn more about the team and what we do.',
|
||||
href: 'https://wiki.elastic.co/display/DEV/AppEx+SharedUX+Team',
|
||||
},
|
||||
]}
|
||||
/>
|
||||
|
||||
<DocRelatedArticles
|
||||
sectionTitle="Our Catalog"
|
||||
items={[
|
||||
{
|
||||
pageId: 'kibDevTutorialsServerlessProjectNavigation',
|
||||
title: 'Serverless Project Navigation',
|
||||
description: 'Learn how to work with the new chrome navigation in serverless projects',
|
||||
},
|
||||
{
|
||||
pageId: 'kibDevTutorialFileService',
|
||||
title: 'File service',
|
||||
description: 'Learn how to add files uploading and downloading to your plugin',
|
||||
},
|
||||
{
|
||||
pageId: 'kibDevSharePluginReadme',
|
||||
title: 'Sharing',
|
||||
description: 'Learn how to add short URLs to your plugin',
|
||||
},
|
||||
{
|
||||
title: 'Content Management',
|
||||
pageId: 'kibContentManagement',
|
||||
description: 'Learn about the content management system in Kibana',
|
||||
},
|
||||
{
|
||||
pageId: 'kibDevTutorialScreenshotting',
|
||||
title: 'Reporting / Screenshotting',
|
||||
description: 'Learn how to integrate your plugin with reporting',
|
||||
},
|
||||
{
|
||||
pageId: 'kibDevTutorialAdvancedSettings',
|
||||
title: 'Advanced Settings (uiSettings)',
|
||||
description: 'Learn how to register advanced settings for your plugin',
|
||||
},
|
||||
{
|
||||
pageId: 'kibDevDocsKPTTutorial',
|
||||
title: 'Kibana Page Template',
|
||||
description: "Learn how to use Kibana Page Template for your app's page layout",
|
||||
},
|
||||
{
|
||||
pageId: 'kibDevReactKibanaContext',
|
||||
title: 'Kibana React Contexts',
|
||||
description: 'Learn how to use common React contexts in Kibana',
|
||||
},
|
||||
]}
|
||||
/>
|
|
@ -25,15 +25,6 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Operations",
|
||||
"items": [
|
||||
{
|
||||
"id": "kibDevDocsOpsOverview",
|
||||
"label": "Overview"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Contributing",
|
||||
"items": [
|
||||
|
@ -149,9 +140,6 @@
|
|||
{
|
||||
"id": "kibDevTutorialExpressions"
|
||||
},
|
||||
{
|
||||
"id": "kibDevDocsKPTTutorial"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialDataSearchAndSessions",
|
||||
"label": "data.search"
|
||||
|
@ -178,23 +166,12 @@
|
|||
},
|
||||
{
|
||||
"id": "kibDevTutorialAdvancedSettings"
|
||||
},
|
||||
{
|
||||
"id": "kibDevSharePluginReadme"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialScreenshotting"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialsContentManagementOnboarding"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialsServerlessProjectNavigation"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Serverless",
|
||||
"pageId": "ktServerlessReleaseOverview",
|
||||
"items": [
|
||||
{
|
||||
"id": "ktServerlessReleaseOverview"
|
||||
|
@ -204,6 +181,61 @@
|
|||
},
|
||||
{
|
||||
"id": "ktCustomServerlessImage"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialsServerlessProjectNavigation"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Operations",
|
||||
"items": [
|
||||
{
|
||||
"id": "kibDevDocsOpsOverview",
|
||||
"label": "Overview"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Shared UX",
|
||||
"pageId": "kibDevDocsSharedUxOverview",
|
||||
"items": [
|
||||
{
|
||||
"label": "Serverless Project Navigation",
|
||||
"id": "kibDevTutorialsServerlessProjectNavigation"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialFileService",
|
||||
"label": "File service"
|
||||
},
|
||||
{
|
||||
"id": "kibDevSharePluginReadme",
|
||||
"label": "Sharing"
|
||||
},
|
||||
{
|
||||
"label": "Content Management",
|
||||
"id": "kibContentManagement",
|
||||
"items": [
|
||||
{
|
||||
"id": "kibDevTutorialsContentManagementOnboarding"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialScreenshotting",
|
||||
"label": "Screenshotting"
|
||||
},
|
||||
{
|
||||
"id": "kibDevTutorialAdvancedSettings",
|
||||
"label": "Advanced Settings"
|
||||
},
|
||||
{
|
||||
"id": "kibDevDocsKPTTutorial",
|
||||
"label": "Kibana Page Template"
|
||||
},
|
||||
{
|
||||
"id": "kibDevReactKibanaContext",
|
||||
"label": "Kibana React Contexts"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
id: react/context
|
||||
slug: /react/context
|
||||
id: kibDevReactKibanaContext
|
||||
slug: /kibana-dev-docs/react-context
|
||||
title: React Contexts in Kibana
|
||||
description: Kibana uses React Context to manage several global states. This is a collection of packages supporting those states.
|
||||
tags: ['shared-ux', 'react', 'context']
|
||||
tags: ['kibana', 'dev','shared-ux', 'react', 'context']
|
||||
date: 2023-07-25
|
||||
---
|
||||
|
||||
|
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
id: kibContentManagement
|
||||
slug: /kibana-dev-docs/content-management
|
||||
title: Content Management
|
||||
date: 2023-04-13
|
||||
tags: ['kibana', 'dev', 'content management', 'saved objects']
|
||||
---
|
||||
|
||||
<DocLandingHero
|
||||
title="🚧 Under construction"
|
||||
description="Here you will find documentation about content management framework in Kibana"
|
||||
/>
|
||||
|
||||
Kibana Saved Objects have traditionally been considered content,
|
||||
but the content management project aims to provide a single abstraction for Kibana and solution content.
|
||||
This includes the registration and collection of content metadata as well as the rendering capabilities, caching layer, backward compatible CRUD & Search APIs,
|
||||
and eventually a collection of new features that enhance content items by adding additional capabilities for personalization, private objects and content folders.
|
||||
|
||||
## Links
|
||||
|
||||
- <DocLink id="kibDevTutorialsContentManagementOnboarding" text="Content Management onboarding" />
|
||||
- <DocLink id="kibContentManagementPluginApi" text="Content Management plugin API reference" />
|
Loading…
Add table
Add a link
Reference in a new issue