Skip to content

Conversation

matschaffer
Copy link
Contributor

When trying to confirm the issues on elastic/beats#30014 I found this readme, but it wasn't clear that I needed a full path until I started reading through https://github.com/elastic/docs/blob/master/doc_build_aliases.sh

Seemed like we should probably clarify that a full path is expected.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM

@matschaffer matschaffer merged commit 997ff1e into elastic:master Feb 2, 2022
@matschaffer matschaffer deleted the readme-clarification branch February 2, 2022 02:34
@gtback
Copy link
Member

gtback commented Feb 2, 2022

Hey @matschaffer, I'm not sure if this is actually required (it doesn't hurt of course, so I'm fine with this change).

I was able to run this command from my local security-docs repo, in order to build the Security docs (the equivalent of docbldsec:

../docs/build_docs --doc docs/index.asciidoc --resource ../stack-docs/docs --chunk 1 --open 

All of the path arguments can be weird and confusing, and I haven't tried with the beats docs. Using the aliases is recommended, both for consistency and to make sure you have all the relevant files that are needed to build a specific book..

@matschaffer
Copy link
Contributor Author

Hrm. Yeah, it seems to work for me without the full path now. Not sure why it didn't the first time.

Sorry I didn't copy the error message.

v1v added a commit to v1v/docs that referenced this pull request Feb 3, 2022
…tral-naming

* upstream/master: (28 commits)
  Fixes .net book generation. (elastic#2367)
  Add main branch to elasticsearch-net repo to docs build. (elastic#2196)
  Update attributes.asciidoc (elastic#2365)
  Note that the full path is required for local doc build (elastic#2364)
  Bump current version to 7.17 (elastic#2333)
  moves old file back to bottom
  add new path for kibana links check
  apm: Neutral naming for apm-agent-java (elastic#2350)
  Change current to MS-68 (elastic#2355)
  Remove unnecessary branch mapping for package-spec (elastic#2359)
  Adds tech preview macro, updates experimental (elastic#2340)
  [DOCS] Add `plugins-7x` and `plugins-6x` attributes (elastic#2358)
  apm: Neutral naming for apm-agent-python (elastic#2348)
  apm: Neutral naming for apm-agent-rum-js (elastic#2354)
  apm: Neutral naming for apm-agent-dotnet (elastic#2352)
  apm: Neutral naming for apm-agent-nodejs (elastic#2353)
  Neutral naming for apm-agent-go (elastic#2351)
  apm: Neutral naming for apm-agent-php (elastic#2349)
  Add 7.last attribute for APM Guide (elastic#2356)
  [apm] main branch for apm-agent-ruby (elastic#2347)
  ...
v1v added a commit to v1v/docs that referenced this pull request Feb 3, 2022
…r-neutral-naming

* upstream/master:
  [DOCS] 8.0.0-rc2 version attributes. (elastic#2345)
  Rename master to main for Beats project (elastic#2337)
  Fixes .net book generation. (elastic#2367)
  Add main branch to elasticsearch-net repo to docs build. (elastic#2196)
  Update attributes.asciidoc (elastic#2365)
  update stack ecs pointer
  adding in new ecs options per the 8.2 sff
  Note that the full path is required for local doc build (elastic#2364)
  Bump current version to 7.17 (elastic#2333)
  moves old file back to bottom
  add new path for kibana links check
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.

3 participants