Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to new docs #7

Merged
merged 3 commits into from
Feb 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ coverage/
.temp
.cache
_site
docs/.vuepress/.cache
docs/.vuepress/.temp
docs/.vuepress/dist
73 changes: 23 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,37 @@
# Lando Elasticsearch Plugin
# Elasticsearch Lando Plugin

The Lando Elasticsearch plugin service.
This is the _official_ [Lando](https://lando.dev) plugin for [Elasticsearch](https://www.elastic.co/elasticsearch/). When installed it...

## Installation
* Allows users to run various `elasticsearch` versions

```bash
# With npm
npm install @lando/elasticsearch
Of course, once a user is running their Elasticsearch project with Lando they can take advantage of [all the other awesome development features](https://docs.lando.dev) Lando provides.

# With yarn
yarn add @lando/elasticsearch
```

## Issues, Questions and Support

If you have a question or would like some community support we recommend you [join us on Slack](https://launchpass.com/devwithlando). Note that this is the Slack community for [Lando](https://lando.dev) but we are more than happy to help with this module as well!

If you'd like to report a bug or submit a feature request then please [use the issue queue](https://github.com/lando/elasticsearch/issues/new/choose) in this repo.

## Changelog

We try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/elasticsearch/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/elasticsearch/releases).
## Basic Usage

Add a `elasticsearch` service to your Landofile

## Development

* Requires [Node 14+](https://nodejs.org/dist/latest-v14.x/)
* Prefers [Yarn](https://classic.yarnpkg.com/lang/en/docs/install)

```bash
git clone https://github.com/lando/elasticsearch.git && cd elasticsearch
yarn install
```yaml
services:
myservice:
type: elasticsearch
```

If you dont' want to install Node 14 or Yarn for whatever reason you can install [Lando](https://docs.lando.dev/basics/installation.html) and use that:
For more info you should check out the [docs](https://docs.lando.dev/elasticsearch):

```bash
git clone https://github.com/lando/elasticsearch.git && cd elasticsearch
# Install deps and get node
lando start
* [Getting Started](https://docs.lando.dev/elasticsearch/)
* [Configuration](https://docs.lando.dev/elasticsearch/config.html)
* [Examples](https://github.com/lando/elasticsearch/tree/main/examples)
* [Development](https://docs.lando.dev/elasticsearch/development.html)

# Run commands
lando node
lando yarn
```

## Testing
## Issues, Questions and Support

```bash
# Lint the code
yarn lint
If you have a question or would like some community support we recommend you [join us on Slack](https://launchpass.com/devwithlando).

# Run unit tests
yarn test
```
If you'd like to report a bug or submit a feature request then please [use the issue queue](https://github.com/lando/elasticsearch/issues/new/choose) in this repo.

## Releasing
## Changelog

```bash
yarn release
```
We try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/elasticsearch/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/elasticsearch/releases).

## Contributors

Expand All @@ -69,6 +41,7 @@ yarn release

Made with [contributors-img](https://contrib.rocks).

## Other Resources
## Other Selected Resources

* [Important advice](https://www.youtube.com/watch?v=WA4iX5D9Z64)
* [LICENSE](https://github.com/lando/elasticsearch/blob/main/LICENSE.md)
* [The best professional advice ever](https://www.youtube.com/watch?v=tkBVDh7my9Q)
41 changes: 25 additions & 16 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,29 +1,38 @@
const {path} = require('@vuepress/utils');
const yaml = require('js-yaml');
const fs = require('fs');

module.exports = {
lang: 'en-US',
title: 'Lando',
description: 'Lando Elasticsearch Plugin Documentation',
base: '/elasticsearch/',
head: [
['meta', {name: 'viewport', content: 'width=device-width, initial-scale=1'}],
['link', {rel: 'preconnect', href: '//fonts.googleapis.com/css?family=Poppins:700|Source+Sans+Pro&display=swap', crossorigin: 'true'}],
['link', {rel: 'icon', href: '/favicon.ico'}],
['link', {rel: 'stylesheet', href: '//fonts.googleapis.com/css?family=Poppins:700|Source+Sans+Pro&display=swap'}],
['link', {rel: 'icon', href: '/elasticsearch/favicon.ico', size: 'any'}],
['link', {rel: 'icon', href: '/elasticsearch/favicon.svg', type: 'image/svg+xml'}],
['link', {rel: 'preconnect', href: '//fonts.googleapis.com'}],
['link', {rel: 'preconnect', href: '//fonts.gstatic.com', crossorigin: true}],
['link', {rel: 'stylesheet', href: '//fonts.googleapis.com/css2?family=Lexend:wght@500&display=swap'}],
],
theme: '@lando/vuepress-theme-lando-docs',
theme: '@lando/vuepress-theme-default-plus',
themeConfig: {
logo: '/images/logo-pink-small.png',
repo: 'lando/elasticsearch',
landoDocs: true,
logo: '/images/icon.svg',
docsDir: 'docs',
docsBranch: 'main',
sponsors: yaml.load(fs.readFileSync(path.resolve(__dirname, 'public') + '/api/sponsors.yml', 'utf8')),
// showSponsors: ['platformsh'],
showCarbonAds: true,
showSponsors: true,
navbar: [
{text: 'Getting Started', link: 'https://docs.lando.dev/basics/'},
repo: 'lando/elasticsearch',
sidebarHeader: {
enabled: true,
title: 'Elasticsearch Plugin',
icon: '/images/elasticsearchicon.png',
},
sidebar: [
{
text: 'Getting Started',
link: '/index.md',
},
'/config.md',
'/support.md',
{text: 'Examples', link: 'https://github.com/lando/elasticsearch/tree/main/examples'},
{text: 'Release Notes', link: 'https://github.com/lando/elasticsearch/releases'},
'/development.md',
],
},
};
16 changes: 0 additions & 16 deletions docs/.vuepress/public/api/sponsors.yml

This file was deleted.

15 changes: 15 additions & 0 deletions docs/.vuepress/public/contact.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

<form class="netlify" name="contact" method="POST" netflify data-netlify="true" hidden>
<p>
<label>Name: <input type="text" name="name" /></label>
</p>
<p>
<label>Email: <input type="email" name="email" /></label>
</p>
<p>
<label>Message: <textarea name="message"></textarea></label>
</p>
<p>
<button type="submit">Submit</button>
</p>
</form>
Binary file modified docs/.vuepress/public/favicon.ico
Binary file not shown.
1 change: 1 addition & 0 deletions docs/.vuepress/public/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.vuepress/public/images/hero-pink.png
Binary file not shown.
Binary file removed docs/.vuepress/public/images/hero-white.png
Binary file not shown.
Binary file removed docs/.vuepress/public/images/hero.png
Binary file not shown.
Binary file added docs/.vuepress/public/images/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/public/images/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.vuepress/public/images/logo-pink-icon.png
Binary file not shown.
Binary file removed docs/.vuepress/public/images/logo-pink-medium.png
Binary file not shown.
Binary file removed docs/.vuepress/public/images/logo-pink-mini.png
Binary file not shown.
Binary file removed docs/.vuepress/public/images/logo-pink-small.png
Binary file not shown.
Binary file removed docs/.vuepress/public/images/logo-small.png
Binary file not shown.
Binary file modified docs/.vuepress/public/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/public/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.vuepress/public/images/seal.png
Binary file not shown.
72 changes: 0 additions & 72 deletions docs/README.md

This file was deleted.

Loading