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

Including dependencies installation details #1693

Merged
merged 2 commits into from
Aug 9, 2021

Conversation

MiguelazoDS
Copy link
Member

Related issue
#1642

Description

This PR includes information related to the dependencies installation required to run the DocGenerator tool.

@MiguelazoDS MiguelazoDS self-assigned this Aug 6, 2021
@@ -164,6 +165,41 @@ block, this action is avoided.

## Usage

### Dependencies

The `requirements.txt` file specifies the required Python modules that need to be installed before running the tool. \
Copy link
Contributor

@palaciosjeremias palaciosjeremias Aug 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ** \ ** isn´t required to split the string. In MarkDown format, one \n is ignored, while 2 \n means a new line.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

```
##### For more options check the official website:

https://www.elastic.co/es/downloads/elasticsearch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this!

Copy link
Contributor

@palaciosjeremias palaciosjeremias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@palaciosjeremias palaciosjeremias merged commit 153bcc2 into dev-doc-generator Aug 9, 2021
@palaciosjeremias palaciosjeremias deleted the dev-1642-documentation-revision branch August 9, 2021 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants