Skip to content

Commit

Permalink
Move snapshot to v0.7
Browse files Browse the repository at this point in the history
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
  • Loading branch information
leecalcote committed Jan 1, 2025
1 parent a3b3618 commit e1d0fb8
Show file tree
Hide file tree
Showing 2,124 changed files with 1,070,277 additions and 0 deletions.
1,747 changes: 1,747 additions & 0 deletions docs/v0.7/guides/configuration-management/importing-designs.html

Large diffs are not rendered by default.

1,736 changes: 1,736 additions & 0 deletions docs/v0.7/guides/configuration-management/importing-models.html

Large diffs are not rendered by default.

1,668 changes: 1,668 additions & 0 deletions docs/v0.7/guides/configuration-management/index.html

Large diffs are not rendered by default.

1,756 changes: 1,756 additions & 0 deletions docs/v0.7/guides/configuration-management/pattern-management.html

Large diffs are not rendered by default.

1,689 changes: 1,689 additions & 0 deletions docs/v0.7/guides/configuration-management/push-pull-model-image.html

Large diffs are not rendered by default.

1,119 changes: 1,119 additions & 0 deletions docs/v0.7/guides/configuration-management/working-with-designs.html

Large diffs are not rendered by default.

1,760 changes: 1,760 additions & 0 deletions docs/v0.7/guides/events-management.html

Large diffs are not rendered by default.

1,811 changes: 1,811 additions & 0 deletions docs/v0.7/guides/infrastructure-management/gitops-with-meshery.html

Large diffs are not rendered by default.

1,611 changes: 1,611 additions & 0 deletions docs/v0.7/guides/infrastructure-management/index.html

Large diffs are not rendered by default.

1,678 changes: 1,678 additions & 0 deletions docs/v0.7/guides/infrastructure-management/lifecycle-management.html

Large diffs are not rendered by default.

1,633 changes: 1,633 additions & 0 deletions docs/v0.7/guides/infrastructure-management/notification-management.html

Large diffs are not rendered by default.

1,714 changes: 1,714 additions & 0 deletions docs/v0.7/guides/infrastructure-management/overview.html

Large diffs are not rendered by default.

1,693 changes: 1,693 additions & 0 deletions docs/v0.7/guides/infrastructure-management/registering-a-connection.html

Large diffs are not rendered by default.

1,703 changes: 1,703 additions & 0 deletions docs/v0.7/guides/infrastructure-management/sample-apps.html

Large diffs are not rendered by default.

2,457 changes: 2,457 additions & 0 deletions docs/v0.7/guides/mesheryctl.html

Large diffs are not rendered by default.

1,815 changes: 1,815 additions & 0 deletions docs/v0.7/guides/mesheryctl/authenticate-with-meshery-via-cli.html

Large diffs are not rendered by default.

1,847 changes: 1,847 additions & 0 deletions docs/v0.7/guides/mesheryctl/configuring-autocompletion-for-mesheryctl.html

Large diffs are not rendered by default.

1,914 changes: 1,914 additions & 0 deletions docs/v0.7/guides/mesheryctl/running-system-checks-using-mesheryctl.html

Large diffs are not rendered by default.

1,827 changes: 1,827 additions & 0 deletions docs/v0.7/guides/mesheryctl/system-commands.html

Large diffs are not rendered by default.

2,008 changes: 2,008 additions & 0 deletions docs/v0.7/guides/mesheryctl/working-with-mesheryctl.html

Large diffs are not rendered by default.

1,618 changes: 1,618 additions & 0 deletions docs/v0.7/guides/operating/model-generation.html

Large diffs are not rendered by default.

2,274 changes: 2,274 additions & 0 deletions docs/v0.7/guides/performance-management.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,758 changes: 1,758 additions & 0 deletions docs/v0.7/guides/performance-management/managing-performance.html

Large diffs are not rendered by default.

1,872 changes: 1,872 additions & 0 deletions docs/v0.7/guides/performance-management/meshery-metrics.html

Large diffs are not rendered by default.

1,822 changes: 1,822 additions & 0 deletions docs/v0.7/guides/performance-management/performance-management.html

Large diffs are not rendered by default.

1,632 changes: 1,632 additions & 0 deletions docs/v0.7/guides/troubleshooting.html

Large diffs are not rendered by default.

1,954 changes: 1,954 additions & 0 deletions docs/v0.7/guides/troubleshooting/installation.html

Large diffs are not rendered by default.

1,892 changes: 1,892 additions & 0 deletions docs/v0.7/guides/troubleshooting/meshery-operator-meshsync.html

Large diffs are not rendered by default.

1,684 changes: 1,684 additions & 0 deletions docs/v0.7/guides/troubleshooting/meshery-server.html

Large diffs are not rendered by default.

1,735 changes: 1,735 additions & 0 deletions docs/v0.7/guides/tutorials.html

Large diffs are not rendered by default.

1,852 changes: 1,852 additions & 0 deletions docs/v0.7/guides/tutorials/deploy-apache-cassandra-with-statefulset.html

Large diffs are not rendered by default.

1,897 changes: 1,897 additions & 0 deletions docs/v0.7/guides/tutorials/deploy-aws-ec2-instances-with-meshery.html

Large diffs are not rendered by default.

1,848 changes: 1,848 additions & 0 deletions docs/v0.7/guides/tutorials/deploy-php-redis.html

Large diffs are not rendered by default.

1,911 changes: 1,911 additions & 0 deletions docs/v0.7/guides/tutorials/exploring-kubernetes-cronjobs.html

Large diffs are not rendered by default.

1,864 changes: 1,864 additions & 0 deletions docs/v0.7/guides/tutorials/kubernetes-configmaps-secrets.html

Large diffs are not rendered by default.

1,873 changes: 1,873 additions & 0 deletions docs/v0.7/guides/tutorials/kubernetes-pods.html

Large diffs are not rendered by default.

1,728 changes: 1,728 additions & 0 deletions docs/v0.7/guides/tutorials/publish-to-artifacthub.html

Large diffs are not rendered by default.

2,009 changes: 2,009 additions & 0 deletions docs/v0.7/guides/tutorials/wordpress-mysql-persistentvolume.html

Large diffs are not rendered by default.

6,646 changes: 6,646 additions & 0 deletions docs/v0.7/index.html

Large diffs are not rendered by default.

3,114 changes: 3,114 additions & 0 deletions docs/v0.7/installation.html

Large diffs are not rendered by default.

1,258 changes: 1,258 additions & 0 deletions docs/v0.7/installation/accessing-meshery-ui.html

Large diffs are not rendered by default.

2,171 changes: 2,171 additions & 0 deletions docs/v0.7/installation/codespaces.html

Large diffs are not rendered by default.

2,955 changes: 2,955 additions & 0 deletions docs/v0.7/installation/compatibility-matrix.html

Large diffs are not rendered by default.

2,171 changes: 2,171 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-cilium-past-results.html

Large diffs are not rendered by default.

5,651 changes: 5,651 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-consul-past-results.html

Large diffs are not rendered by default.

40,780 changes: 40,780 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-istio-past-results.html

Large diffs are not rendered by default.

7,025 changes: 7,025 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-kuma-past-results.html

Large diffs are not rendered by default.

11,497 changes: 11,497 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-linkerd-past-results.html

Large diffs are not rendered by default.

6,617 changes: 6,617 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-nginx-sm-past-results.html

Large diffs are not rendered by default.

7,286 changes: 7,286 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-osm-past-results.html

Large diffs are not rendered by default.

10,061 changes: 10,061 additions & 0 deletions docs/v0.7/installation/compatibility-matrix/meshery-traefik-mesh-past-results.html

Large diffs are not rendered by default.

2,021 changes: 2,021 additions & 0 deletions docs/v0.7/installation/docker.html

Large diffs are not rendered by default.

2,059 changes: 2,059 additions & 0 deletions docs/v0.7/installation/docker/docker-extension.html

Large diffs are not rendered by default.

2,133 changes: 2,133 additions & 0 deletions docs/v0.7/installation/kubernetes.html

Large diffs are not rendered by default.

2,186 changes: 2,186 additions & 0 deletions docs/v0.7/installation/kubernetes/aks.html

Large diffs are not rendered by default.

2,144 changes: 2,144 additions & 0 deletions docs/v0.7/installation/kubernetes/eks.html

Large diffs are not rendered by default.

2,144 changes: 2,144 additions & 0 deletions docs/v0.7/installation/kubernetes/gke.html

Large diffs are not rendered by default.

2,062 changes: 2,062 additions & 0 deletions docs/v0.7/installation/kubernetes/helm.html

Large diffs are not rendered by default.

2,137 changes: 2,137 additions & 0 deletions docs/v0.7/installation/kubernetes/kind.html

Large diffs are not rendered by default.

2,024 changes: 2,024 additions & 0 deletions docs/v0.7/installation/kubernetes/kubesphere.html

Large diffs are not rendered by default.

2,266 changes: 2,266 additions & 0 deletions docs/v0.7/installation/kubernetes/minikube.html

Large diffs are not rendered by default.

2,677 changes: 2,677 additions & 0 deletions docs/v0.7/installation/linux-mac.html

Large diffs are not rendered by default.

1,866 changes: 1,866 additions & 0 deletions docs/v0.7/installation/linux-mac/bash.html

Large diffs are not rendered by default.

1,885 changes: 1,885 additions & 0 deletions docs/v0.7/installation/linux-mac/brew.html

Large diffs are not rendered by default.

2,067 changes: 2,067 additions & 0 deletions docs/v0.7/installation/mesheryctl.html

Large diffs are not rendered by default.

1,832 changes: 1,832 additions & 0 deletions docs/v0.7/installation/multiple-adapters.html

Large diffs are not rendered by default.

1,898 changes: 1,898 additions & 0 deletions docs/v0.7/installation/playground.html

Large diffs are not rendered by default.

1,289 changes: 1,289 additions & 0 deletions docs/v0.7/installation/quick-start.html

Large diffs are not rendered by default.

2,027 changes: 2,027 additions & 0 deletions docs/v0.7/installation/upgrades.html

Large diffs are not rendered by default.

2,580 changes: 2,580 additions & 0 deletions docs/v0.7/installation/windows.html

Large diffs are not rendered by default.

2,451 changes: 2,451 additions & 0 deletions docs/v0.7/installation/windows/scoop.html

Large diffs are not rendered by default.

492 changes: 492 additions & 0 deletions docs/v0.7/lib/tasks/helper.rb

Large diffs are not rendered by default.

51 changes: 51 additions & 0 deletions docs/v0.7/lib/tasks/renderer.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# frozen_string_literal: true
# require './helper'
require "haml"
module Graphql
module Docs
# This is a custom verion of Gitlab renderer for graphql-docs for Meshery.
# Uses HAML templates to parse markdown and generate .md files.
# It uses graphql-docs helpers and schema parser, more information in https://github.com/gjtorikian/graphql-docs.
#
# Arguments:
# schema - the GraphQL schema definition.
# output_dir: The folder where the markdown files will be saved
# template: The path of the haml template to be parsed
class Renderer
include Graphql::Docs::Helper

attr_reader :schema

def initialize(schema, output_dir, template)
@output_dir = output_dir
@template = template
@schema = schema
@layout = Haml::Engine.new(File.read(template))
@parsed_schema = GraphQLDocs::Parser.new(schema, {}).parse
@seen = Set.new
end

def contents
# Render and remove an extra trailing new line
@contents ||= @layout.render(self).sub!(/\n(?=\Z)/, '')
end

def write
filename = File.join(@output_dir, 'graphql-api-reference.md')

FileUtils.mkdir_p(@output_dir)
File.write(filename, contents)
end

private

def seen_type?(name)
@seen.include?(name)
end

def seen_type!(name)
@seen << name
end
end
end
end
173 changes: 173 additions & 0 deletions docs/v0.7/lib/tasks/templates/default.md.haml
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
-# haml-lint:disable UnnecessaryStringOutput
= auto_generated_comment

:plain
Self-generated API documentation for Meshery's GraphQL API. The API can be explored interactively using the [GraphQL Playground](./extensibility). Documentation is generated from Meshery's GraphQL schema. Each table below documents a GraphQL type.

WARNING:
Fields that are deprecated are marked with **{warning-solid}**.

<!-- vale off -->
\

:plain
## `Query` type

The `Query` type contains the API's top-level entry points for all executable queries.
\

- fields_of('Query').each do |field|
= render_full_field(field, heading_level: 3, owner: 'Query')
\

:plain
## `Mutation` type

The `Mutation` type contains all the mutations you can execute.

All mutations receive their arguments in a single input object named `input`.

\

- mutations.each do |field|
= render_full_field(field, heading_level: 3, owner: 'Mutation')
\


:plain
## `Subscription` type

The `Subscription` type contains all the Subscriptions you can listen to.


\


- subscriptions.each do |field|
= render_full_field(field, heading_level: 3, owner: 'Subscription')
\

:plain
## Object types

Object types represent the resources that the Meshery GraphQL API can return.
They contain _fields_. Each field has its own type, which will either be one of the
basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types)
(e.g.: `String` or `Boolean`) or other object types. Fields may have arguments.
Fields with arguments are exactly like top-level queries, and are listed beneath
the table of fields for each object type.

For more information, see
[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields)
on `graphql.org`.
\

- object_types.each do |type|
= render_name_and_description(type)
\
= render_object_fields(type[:fields], owner: type)
\

:plain
## Enumeration types

Also called _Enums_, enumeration types are a special kind of scalar that
is restricted to a particular set of allowed values.

For more information, see
[Enumeration Types](https://graphql.org/learn/schema/#enumeration-types)
on `graphql.org`.
\

- enums.each do |enum|
= render_name_and_description(enum)
\
~ "| Value | Description |"
~ "| ----- | ----------- |"
- enum[:values].each do |value|
= render_enum_value(enum, value)
\

:plain
## Scalar types

Scalar values are atomic values, and do not have fields of their own.
Basic scalars include strings, boolean values, and numbers. This schema also
defines various custom scalar values, such as types for times and dates.

This schema includes custom scalar types for identifiers, with a specific type for
each kind of object.

For more information, read about [Scalar Types](https://graphql.org/learn/schema/#scalar-types) on `graphql.org`.
\

- graphql_scalar_types.each do |type|
= render_name_and_description(type)
\

-# Current GraphQL is not using Abstract Types. Can be uncommented for future use.
-# :plain
-# ## Abstract types
-# Abstract types (unions and interfaces) are ways the schema can represent
-# values that may be one of several concrete types.
-# - A [`Union`](https://graphql.org/learn/schema/#union-types) is a set of possible types.
-# The types might not have any fields in common.
-# - An [`Interface`](https://graphql.org/learn/schema/#interfaces) is a defined set of fields.
-# Types may `implement` an interface, which
-# guarantees that they have all the fields in the set. A type may implement more than
-# one interface.
-# See the [GraphQL documentation](https://graphql.org/learn/) for more information on using
-# abstract types.
-# \
-# :plain
-# ### Unions
-# \
-# - graphql_union_types.each do |type|
-# = render_name_and_description(type, level: 4)
-# \
-# One of:
-# \
-# - type[:possible_types].each do |member|
-# = render_union_member(member)
-# \
-# :plain
-# ### Interfaces
-# \
-# - interfaces.each do |type|
-# = render_name_and_description(type, level: 4)
-# \
-# Implementations:
-# \
-# - type[:implemented_by].each do |type_name|
-# ~ "- [`#{type_name}`](##{type_name.downcase})"
-# \
-# = render_object_fields(type[:fields], owner: type, level_bump: 1)
-# \
:plain
## Input types

Types that may be used as arguments (all scalar types may also
be used as arguments).

Only general use input types are listed here. For mutation input types,
see the associated mutation type above.

For more information, read about [Scalar Types](https://graphql.org/learn/schema/#input-types) on `graphql.org`.

\

- input_types.each do |type|
= render_name_and_description(type)
\
= render_argument_table(3, type[:input_fields], type[:name])
\
Loading

0 comments on commit e1d0fb8

Please sign in to comment.