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

Merge x-pack/docs into docs #30665

Closed
4 of 5 tasks
lcawl opened this issue May 17, 2018 · 10 comments
Closed
4 of 5 tasks

Merge x-pack/docs into docs #30665

lcawl opened this issue May 17, 2018 · 10 comments
Assignees
Labels
:Delivery/Build Build or test infrastructure >docs General docs changes Team:Delivery Meta label for Delivery team Team:Docs Meta label for docs team

Comments

@lcawl
Copy link
Contributor

lcawl commented May 17, 2018

The X-Pack-specific documentation currently resides in https://github.com/elastic/elasticsearch/tree/master/x-pack/docs, but in the long term (now that X-Pack is installed with Elasticsearch), that separation is not required.

The Elasticsearch Reference documentation builds (and navigation tree) will be simpler if we no longer have to pull content from these separate directories.

The following items would need to be addressed:

Add "en" folder under elasticsearch/docs? This currently exists in the elasticsearch/x-pack/docs folder and was added to accommodate translation.

See also elastic/kibana#19156 and elastic/logstash#9596

@lcawl lcawl added >docs General docs changes v7.0.0 v6.4.0 labels May 17, 2018
@lcawl lcawl self-assigned this May 17, 2018
@colings86 colings86 added the :Core/Infra/Core Core issues without another label label May 17, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@nik9000
Copy link
Member

nik9000 commented May 23, 2018

Determining whether it is still necessary to highlight pages that contain X-Pack-specific content.

Personally, I'd like to keep marking things as oss and the license level.

Can we stop generating OSS-only versions of the Elasticsearch Reference?

The last time I tried to do it they didn't work and I don't think anyone had noticed for a few days. As much as I want to keep all the OSS stuff, I think we can probably pitch this.

Ensuring that X-Pack-related code snippets can be tested successfully after the move. Does this mean that we need a way to flag code snippets that involve non-Basic features?

So my plan is to switch the docs build to running the zip distribution (the default one, the one with xpack). After I do that you can just move snippets and it should be fine. I'll see about developing a way run against the oss-zip in a followup change. That'd mean skipping the tests that we can't run based on distribution. My plan would be to scan that information out of the markings that you have at the top of the page to show what APIs require xpack/don't work with the oss distribution.

@nik9000
Copy link
Member

nik9000 commented Jun 4, 2018

So my plan is to switch the docs build to running the zip distribution (the default one, the one with xpack).

I've started work on this. I think you'll be able to do ./gradlew -p docs check and get xpack installed and do ./gradlew -p docs check -Dtests.distribution=oss-zip and get the oss-zip distribution installed. After I'm done with my change both should work. So you can start to port things from the xpack docs to Elasticsearch's docs so long as you pick some consistent way to mark the x-pack only ones. Once you have a few examples of that I should be able to build a thing to skip them if you do -Dtests.distribution=oss-zip.

@lcawl
Copy link
Contributor Author

lcawl commented Jun 5, 2018

@nik9000 Would another option be to have a new string like this under the code example?:
// TEST[level:gold]

@lcawl
Copy link
Contributor Author

lcawl commented Jun 5, 2018

I tested putting "// Comment" strings at the top of the files in #31114 and it was causing doc build errors. It works, however, when I code them as attributes (similar to the current "role"="xpack" attributes). e.g. [testenv="gold+"] We could pick whatever attribute name we wanted, as long as it didn't affect existing attributes that are used by the CSS.

@lcawl
Copy link
Contributor Author

lcawl commented Jun 7, 2018

@nik9000 Just to clarify--do I actually need to specify the license level for testing purposes? Or could all the non-oss tests run on a trial license with all the features enabled? That seems like simpler setup to me.

@nik9000
Copy link
Member

nik9000 commented Jun 7, 2018

I'd prefer you specify the license level though I don't think the tests will use it at first. I'd just like to have it specified so we can automatically stick it on the page and then we can test it at a later date.

nik9000 added a commit to nik9000/elasticsearch that referenced this issue Jun 11, 2018
This switches the docs tests from the `oss-zip` distribution to the
`zip` distribution so they have xpack installed and configured with the
default basic license. The goal is to be able to merge the
`x-pack/docs` directory into the `docs` directory, marking the x-pack
docs with some kind of marker. This is the first step in that process.

This also enables `-Dtests.distribution` support for the `docs`
directory so you can run the tests against the `oss-zip` distribution
with something like
```
./gradlew -p docs check -Dtests.distribution=oss-zip
```

We can set up Jenkins to run both.

Relates to elastic#30665
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Jun 11, 2018
This will allow us to merge xpack docs into the regular docs directory!

Relates to elastic#30665
@wchrisdean
Copy link
Contributor

[doc issue triage]

@rjernst rjernst added Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team labels May 4, 2020
@rjernst rjernst added the needs:triage Requires assignment of a team area label label Dec 3, 2020
@gwbrown gwbrown added :Delivery/Build Build or test infrastructure and removed :Core/Infra/Core Core issues without another label needs:triage Requires assignment of a team area label labels Dec 16, 2020
@elasticmachine elasticmachine added Team:Delivery Meta label for Delivery team and removed Team:Core/Infra Meta label for core/infra team labels Dec 16, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@lcawl
Copy link
Contributor Author

lcawl commented Dec 17, 2020

I think it's no longer appropriate to solve the remaining item in the current docs system.

@lcawl lcawl closed this as completed Dec 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Build Build or test infrastructure >docs General docs changes Team:Delivery Meta label for Delivery team Team:Docs Meta label for docs team
Projects
None yet
Development

No branches or pull requests

10 participants