Skip to content

Commit

Permalink
visualizer/designer
Browse files Browse the repository at this point in the history
Signed-off-by: Lee Calcote <[email protected]>
  • Loading branch information
leecalcote committed Oct 29, 2023
1 parent 57b6d20 commit 10b8ecd
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
15 changes: 15 additions & 0 deletions content/en/meshmap/designer/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Designer
weight: 4
type: docs
description: >
Designer mode is for those who want to create their own MeshMap, using the palette of components provided by Meshery.
---

{{% pageinfo %}}
Collaborate with your team to create a Design. Enable collaboration mode using the Options mode available in the MeshMap canvas
{{% /pageinfo %}}

For many projects, users may not need much information beyond the information in the [Overview](/docs/overview/), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.

Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.
14 changes: 14 additions & 0 deletions content/en/meshmap/visualizer/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Visualizer
weight: 5
description: >
Visualizer mode is for operating your Kubernetes clusters and cloud native infrastructure.
---

{{% pageinfo %}}
Discover and visualize your Kubernetes clusters and cloud native infrastructure.
{{% /pageinfo %}}

For many projects, users may not need much information beyond the information in the [Overview](/docs/overview/), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.

Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.

0 comments on commit 10b8ecd

Please sign in to comment.