How to contribute to edits on the website documentation

Meta Elastic
1

Hi all,

I hope this finds everyone well.

I've been looking around but after, what I believe is incorrect as regards process, making a pull request for a documentation error on the elastic.co website for getting set up with a linux install.

I've since scrapped the pull request and wanted to create it as an issue, as per the contribution guidelines. However, on your github, it appears to only focus on the following, or to create a blank issue:

From Sign in to GitHub · GitHub

Bug

Report a confirmed bug. For unconfirmed bugs please visit Elasticsearch - Discuss the Elastic Stack

Feature Request

Request a new feature we haven't thought of

Test Failure

A test failure in CI

Report a security vulnerability

Please review our security policy for more details

Question

Ask (and answer) questions here.

I was wondering where the most correct location is to submit documentation on the website requests?

Thanks in advance!

2

Could you share here the link of the page which has an issue?

3

Hi David,

On the page Install Elasticsearch from archive on Linux or MacOS | Elasticsearch Guide [8.1] | Elastic

Under "Check that Elasticsearch is running"

The following:
curl --cacert $ES_PATH_CONF/certs/http_ca.crt -u elastic https://localhost:9200

Does not work.

I believe it should now be:

curl --cacert $ES_PATH_CONF/config/certs/http_ca.crt -u elastic https://localhost:9200

Which does return the json as expected.

Do let me know if you'd like more information!

4

Awesome.

So could you just click on the edit button on that page? It will open Sign in to GitHub · GitHub where you can propose your changes.

Would that work?

Thanks again

5

Hi David,

I did create a pull request, but this is out of the normal protocol for how to submit these items so I removed it and opened this post, since there seems to be a process for submitting items as an issue before creating a pull request.

If just creating a pull request is the correct way to approach this, I can recreate it if so?

I just want to make sure I'm not causing someone a headache by performing the wrong action - documentation is an area that I've found every project has their own approach to!

6

Yes. Please open a PR for this. :wink:

7

Done! Thank you for your help, the request is #85364.

If anything amiss, do let me know!

8

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.