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

Convert ECS doc from MD to asciidoc guide: initial setup #266

Merged
merged 3 commits into from
Dec 13, 2018

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Dec 10, 2018

Convert ECS readme.md file to asciidoc to be published at https://www.elastic.co/guide/index.html.
https://ecs-simple.firebaseapp.com/

Issue #276 opened to track additional steps

@ruflin
Copy link
Contributor

ruflin commented Dec 11, 2018

@karenzone Would it make sense to get this in master rather soonish so we could start to play around with the docs builds? Or can we do this also when it's in a branch?

@karenzone
Copy link
Contributor Author

@karenzone Would it make sense to get this in master rather soonish so we could start to play around with the docs builds? Or can we do this also when it's in a branch?

What is there so far is in decent shape. It builds without error. There's more I want to do, but moving v1 into Master wouldn't prevent that. I'm good with move to master if you are. Thanks for taking time to look at this.

@ruflin
Copy link
Contributor

ruflin commented Dec 12, 2018

Now that we branched out 1.0 this can go into master. What are the commands you run the build the docs? I'm thinking of adding a make command for it so it's easy for everyone to build it.

@karenzone
Copy link
Contributor Author

karenzone commented Dec 12, 2018

It requires the elastic/docs repo. I build it locally using ./build_docs.pl --doc ../ecs/docs/index.asciidoc --chunk=1 -open

@ruflin
Copy link
Contributor

ruflin commented Dec 13, 2018

Just opened #275 so we can have an automated docs build in the future.

@karenzone Happy to get yours in first and then rebase mine on top. The firebase link you posted is also very useful.

Copy link
Contributor

@ruflin ruflin left a comment

Choose a reason for hiding this comment

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

I assume so far it's mostly copy/paste of the existing content and no major changes happened?

@karenzone
Copy link
Contributor Author

karenzone commented Dec 13, 2018

@ruflin Some reformatting required. For example:

  • Link format is different between Markdown and asciidoc. [here](https://github.com/elastic/ecs/releases) vs https://github.com/elastic/ecs/releases[official releases]
  • I manually removed the </br> tags because they were rendering in finished doc
  • I think I had to reformat lists.

@ruflin
Copy link
Contributor

ruflin commented Dec 13, 2018

Sounds like no content changes to me then. I'm ok with merging.

@karenzone karenzone changed the title WIP: Convert ECS doc from MD to asciidoc guide Convert ECS doc from MD to asciidoc guide: initial setup Dec 13, 2018
@karenzone karenzone merged commit ab02d05 into elastic:master Dec 13, 2018
@karenzone karenzone deleted the ecs-guide branch December 13, 2018 14:51
webmat pushed a commit to webmat/ecs that referenced this pull request Mar 5, 2019
* ECS doc conversion from md to asciidoc

* Add back uc-header file

* New asciidoc files
webmat added a commit that referenced this pull request Mar 5, 2019
…ial setup (#266) (#370)

Backport of PR #266 to 1.0 branch. Original message:

* ECS doc conversion from md to asciidoc
* Add back uc-header file
* New asciidoc files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants