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.

Sign up for GitHub

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

Jump to bottom

Update metadocs steps #1238

Merged
merged 3 commits into from
Jan 12, 2019
Merged

Update metadocs steps #1238

merged 3 commits into from
Jan 12, 2019

Conversation

calvellido
Copy link
Member

@calvellido calvellido commented Jan 11, 2019 •
edited by JorgeCastilloPrz
Loading

Fixes #1239

  • Update metadocs steps to better reflect what is needed to be completed in order to get the docs properly running locally.

@calvellido
Update metadocs steps
07685e4 
* Update metadocs steps to better reflect what is needed to be completed in order to get the docs properly running locally.
JorgeCastilloPrz
JorgeCastilloPrz approved these changes Jan 11, 2019
View reviewed changes
Copy link
Member

@JorgeCastilloPrz JorgeCastilloPrz left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this, you were fast 😄. I've added a couple of optional suggestions.

modules/docs/arrow-docs/README.md Outdated

Ank is in charge of compiling and validating your doc snippets and deploying the proper binaries for those. Run the following command:
Dokka is responsible of generating documentation based on source code annotations, while Ank is in charge of compiling and validating your doc snippets and deploying the proper binaries for those. Run the following commands in Arrow root dir:
Copy link
Member

Choose a reason for hiding this comment

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

Can we be explicit about the ordering? It's important to note that you must run dokka first so Ank can copy over all the generated files afterwards.
I'd personally also highlight the "in Arrow root dir" with bold style or something.

Copy link
Member Author

Choose a reason for hiding this comment

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

I’ve addressed your comments, thanks @JorgeCastilloPrz

modules/docs/arrow-docs/README.md Outdated Show resolved Hide resolved
JorgeCastilloPrz
JorgeCastilloPrz approved these changes Jan 11, 2019
View reviewed changes
Copy link
Member

@JorgeCastilloPrz JorgeCastilloPrz left a comment

Choose a reason for hiding this comment

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

Ty for the raid fix! Feel free to merge.

@calvellido calvellido merged commit b4320ac into master Jan 12, 2019
@calvellido calvellido deleted the jv-update-metadocs-steps branch January 12, 2019 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JorgeCastilloPrz JorgeCastilloPrz JorgeCastilloPrz approved these changes

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@calvellido @JorgeCastilloPrz