mirror of https://github.com/dapr/docs.git
Updated overview structure
This commit is contained in:
parent
28d95840cc
commit
cb5bb77f52
|
@ -1,4 +1,5 @@
|
|||
# Visual Studio 2015/2017/2019 cache/options directory
|
||||
.vs/
|
||||
package-lock.json
|
||||
node_modules/
|
||||
node_modules/
|
||||
daprdocs/public
|
|
@ -1,11 +1,81 @@
|
|||
# Site Configuration
|
||||
baseURL = "https://docs.dapr.io"
|
||||
languageCode = "en-us"
|
||||
contentDir = "content/en"
|
||||
defaultContentLanguage = "en"
|
||||
title = "Dapr Docs"
|
||||
theme = "docsy"
|
||||
|
||||
# Language Configuration
|
||||
languageCode = "en-us"
|
||||
contentDir = "content/en"
|
||||
defaultContentLanguage = "en"
|
||||
|
||||
# GitHub Information
|
||||
enableGitInfo = true
|
||||
github_repo = "https://github.com/dapr/docs"
|
||||
github_project_repo = "https://github.com/dapr/dapr"
|
||||
github_subdir = "daprdocs"
|
||||
|
||||
# Top Nav Bar
|
||||
[[menu.main]]
|
||||
name = "Home"
|
||||
weight = 40
|
||||
url = "https://dapr.io"
|
||||
[[menu.main]]
|
||||
name = "About"
|
||||
weight = 50
|
||||
url = "https://dapr.io/#about"
|
||||
[[menu.main]]
|
||||
name = "Download"
|
||||
weight = 60
|
||||
url = "https://dapr.io/#download"
|
||||
[[menu.main]]
|
||||
name = "Docs"
|
||||
weight = 70
|
||||
url = "#"
|
||||
[[menu.main]]
|
||||
name = "Community"
|
||||
weight = 80
|
||||
url = "https://dapr.io/#community"
|
||||
|
||||
[params]
|
||||
#privacy_policy = "https://policies.google.com/privacy"
|
||||
|
||||
# UI Customization
|
||||
[params.ui]
|
||||
sidebar_menu_compact = true
|
||||
navbar_logo = true
|
||||
|
||||
# Versioning
|
||||
version_menu = "Releases"
|
||||
version = "v0.10"
|
||||
archived_version = false
|
||||
[[params.versions]]
|
||||
version = "Latest"
|
||||
url = "#"
|
||||
[[params.versions]]
|
||||
version = "v0.10"
|
||||
url = "https://github.com/dapr/docs/tree/v0.10.0"
|
||||
[[params.versions]]
|
||||
version = "v0.9"
|
||||
url = "https://github.com/dapr/docs/tree/v0.9.0"
|
||||
[[params.versions]]
|
||||
version = "v0.8"
|
||||
url = "https://github.com/dapr/docs/tree/v0.8.0"
|
||||
|
||||
# Links
|
||||
## End user relevant links. These will show up on left side of footer and in the community page if you have one.
|
||||
[[params.links.user]]
|
||||
name ="Twitter"
|
||||
url = "https://twitter.com/daprdev"
|
||||
icon = "fab fa-twitter"
|
||||
desc = "Follow us on Twitter to get the latest updates!"
|
||||
[[params.links.user]]
|
||||
name = "YouTube"
|
||||
url = "https://www.youtube.com/channel/UCtpSQ9BLB_3EXdWAUQYwnRA"
|
||||
icon = "fab fa-youtube"
|
||||
desc = "Community call recordings and other cool demos"
|
||||
## Developer relevant links. These will show up on right side of footer and in the community page if you have one.
|
||||
[[params.links.developer]]
|
||||
name = "GitHub"
|
||||
url = "https://github.com/dapr/"
|
||||
icon = "fab fa-github"
|
||||
desc = "Development takes place here!"
|
|
@ -7,39 +7,6 @@ description: >
|
|||
Docs, references, and best-practices for the Dapr project.
|
||||
---
|
||||
|
||||
# 📖 Dapr documentation
|
||||
|
||||
Welcome to the Dapr documentation repository. You can learn more about Dapr from the links below.
|
||||
|
||||
|
||||
## Document versions
|
||||
|
||||
Dapr is currently under community development in preview phase and master branch could include breaking changes. Therefore, please ensure that you refer to the right version of the documents for your Dapr runtime version.
|
||||
|
||||
| Version | Repo |
|
||||
|:-------:|:----:|
|
||||
| v0.10.0 | [Docs](https://github.com/dapr/docs/tree/v0.10.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.10.0) - [CLI](https://github.com/dapr/cli/tree/release-0.10)
|
||||
| v0.9.0 | [Docs](https://github.com/dapr/docs/tree/v0.9.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.9.0) - [CLI](https://github.com/dapr/cli/tree/release-0.9)
|
||||
| v0.8.0 | [Docs](https://github.com/dapr/docs/tree/v0.8.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.8.0) - [CLI](https://github.com/dapr/cli/tree/release-0.8)
|
||||
| v0.7.0 | [Docs](https://github.com/dapr/docs/tree/v0.7.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.7.0) - [CLI](https://github.com/dapr/cli/tree/release-0.7)
|
||||
| v0.6.0 | [Docs](https://github.com/dapr/docs/tree/v0.6.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.6.0) - [CLI](https://github.com/dapr/cli/tree/release-0.6)
|
||||
| v0.5.0 | [Docs](https://github.com/dapr/docs/tree/v0.5.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.5.0) - [CLI](https://github.com/dapr/cli/tree/release-0.5)
|
||||
| v0.4.0 | [Docs](https://github.com/dapr/docs/tree/v0.4.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.4.0) - [CLI](https://github.com/dapr/cli/tree/release-0.4)
|
||||
| v0.3.0 | [Docs](https://github.com/dapr/docs/tree/v0.3.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.3.0) - [CLI](https://github.com/dapr/cli/tree/release-0.3)
|
||||
| v0.2.0 | [Docs](https://github.com/dapr/docs/tree/v0.2.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.2.0) - [CLI](https://github.com/dapr/cli/tree/release-0.2)
|
||||
| v0.1.0 | [Docs](https://github.com/dapr/docs/tree/v0.1.0) - [Runtime](https://github.com/dapr/dapr/tree/v0.1.0) - [CLI](https://github.com/dapr/cli/tree/release-0.1)
|
||||
|
||||
## Contents
|
||||
|
||||
| Topic | Description |
|
||||
|-------|-------------|
|
||||
|**[Overview](./overview)** | An overview of Dapr and how it enables you to build event driven, distributed applications
|
||||
|**[Getting Started](./getting-started)** | Set up your development environment
|
||||
|**[Concepts](./concepts)** | Dapr concepts explained
|
||||
|**[How-Tos](./howto)** | Guides explaining how to accomplish specific tasks
|
||||
|**[Best Practices](./best-practices)** | Guides explaining best practices when using Dapr
|
||||
|**[Reference](./reference)** | API and bindings reference documentation
|
||||
|**[FAQ](FAQ.md)** | Frequently asked questions
|
||||
|
||||
## Further documentation
|
||||
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "Building Blocks"
|
||||
weight: 20
|
||||
linkTitle: "Building Blocks"
|
||||
weight: 30
|
||||
description: "HTTP or gRPC API that can be called from user code and uses one or more Dapr components."
|
||||
---
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: "Dapr Concepts"
|
||||
linkTitle: "Concepts"
|
||||
weight: 20
|
||||
weight: 10
|
||||
---
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Dapr Architecture"
|
||||
linkTitle: "Architecture"
|
||||
weight: 20
|
||||
description: >
|
||||
Information on how Dapr is architected and implemented.
|
||||
---
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Dapr Building Blocks"
|
||||
linkTitle: "Building Blocks"
|
||||
weight: 200
|
||||
description: ""
|
||||
---
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Dapr Components"
|
||||
linkTitle: "Components"
|
||||
weight: 10
|
||||
weight: 100
|
||||
description: "Modular pieces of functionality used in Dapr."
|
||||
---
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Middleware Pipeline"
|
||||
linkTitle: "Middleware"
|
||||
weight: 50
|
||||
weight: 300
|
||||
---
|
||||
|
||||
# Middleware pipeline
|
|
@ -1,8 +1,10 @@
|
|||
# FAQ
|
||||
|
||||
- **[Networking and service meshes](#networking-and-service-meshes)**
|
||||
- **[Actors](#actors)**
|
||||
- **[Developer language SDKs and frameworks](#developer-language-sdks-and-frameworks)**
|
||||
---
|
||||
title: "Frequently Asked Questions and Answers"
|
||||
linkTitle: "FAQs"
|
||||
weight: 60
|
||||
description: >
|
||||
Common questions we get asked about Dapr
|
||||
---
|
||||
|
||||
## Networking and service meshes
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Dapr Overview"
|
||||
linkTitle: "Overview"
|
||||
weight: 10
|
||||
description: >
|
||||
Introduction to the Distributed Application Runtime
|
||||
---
|
||||
|
||||
Welcome to the Dapr documentation repository. You can learn more about Dapr from the links below.
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Dapr Security"
|
||||
linkTitle: "Security"
|
||||
weight: 60
|
||||
weight: 30
|
||||
description: >
|
||||
How Dapr is designed with security in mind for your enterprise deployments.
|
||||
---
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Dapr Walkthroughs"
|
||||
linkTitle: "Walkthroughs"
|
||||
weight: 40
|
||||
description: >
|
||||
Step-by-step walkthoughs on what happens under the hood of Dapr.
|
||||
---
|
|
@ -1,18 +1,12 @@
|
|||
---
|
||||
title: "Environment Options for Hosting Dapr"
|
||||
linkTitle: "Hosting Environments"
|
||||
weight: 50
|
||||
title: "Deploying Dapr"
|
||||
linkTitle: "Deploying"
|
||||
weight: 40
|
||||
description: "Hosting options, best-practices, and other guides and running your application on Dapr."
|
||||
---
|
||||
|
||||
|
||||
# Hosting environments
|
||||
|
||||
Dapr can run on multiple hosting platforms.
|
||||
|
||||
## Contents
|
||||
- [Running Dapr on a local developer machine in self hosted mode](#running-dapr-on-a-local-developer-machine-in-self-hosted-mode)
|
||||
- [Running Dapr in Kubernetes mode](#running-dapr-in-kubernetes-mode)
|
||||
|
||||
## Running Dapr on a local developer machine in self hosted mode
|
||||
|
||||
Dapr can be configured to run on your local developer machine in [self hosted mode](../getting-started). Each running service has a Dapr runtime process (or sidecar) which is configured to use state stores, pub/sub, binding components and the other building blocks.
|
||||
|
@ -44,4 +38,4 @@ Deploying and running a Dapr enabled application into your Kubernetes cluster is
|
|||
```
|
||||
You can see some examples [here](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes/deploy) in the Kubernetes getting started sample.
|
||||
|
||||
Read [Kubernetes how to topics](https://github.com/dapr/docs/tree/master/howto#kubernetes-configuration) for more information about setting up Kubernetes and Dapr.
|
||||
Read [Kubernetes how to topics](https://github.com/dapr/docs/tree/master/howto#kubernetes-configuration) for more information about setting up Kubernetes and Dapr.
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Getting Started with Dapr"
|
||||
linkTitle: "Getting Started"
|
||||
weight: 1
|
||||
weight: 20
|
||||
description: >
|
||||
How to get up and running with Dapr
|
||||
---
|
||||
|
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "SDKs & Integrations"
|
||||
weight: 50
|
||||
description: "Information on ways you can build and develop with Dapr using your favorite languages and frameworks."
|
||||
---
|
|
@ -1,10 +0,0 @@
|
|||
<br /><br />
|
||||
<h3><b>Table of Contents:</b></h3>
|
||||
{{ partial "page-meta-links.html" . }}
|
||||
{{ if not .Params.notoc }}
|
||||
{{ with .TableOfContents }}
|
||||
{{ if ge (len .) 200 }}
|
||||
{{ . }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
Loading…
Reference in New Issue