Skip to content
This repository has been archived by the owner on Aug 22, 2019. It is now read-only.

restructure training and policies and fallback actions docs #1838

Merged
merged 8 commits into from Mar 15, 2019

Conversation

erohmensing
Copy link
Contributor

Proposed changes:

  • fixes #1678 master changes (see issue for detailed list of changes)

Probably best to code review by pulling the branch and making the livedocs.

Status (please check what you already did):

  • made PR ready for code review
  • added some tests for the functionality
  • updated the documentation
  • updated the changelog

@codeclimate
Copy link

codeclimate bot commented Mar 14, 2019

Code Climate has analyzed commit fcde2d3 and detected 0 issues on this pull request.

View more on Code Climate.

Copy link
Contributor

@JustinaPetr JustinaPetr left a comment

Choose a reason for hiding this comment

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

Looks great @erohmensing ! The only thing is that in policies page the sizing of the headers are getting a bit confusing. In Fallback Policies section we have a small header for the policy name and then a bigger header for the Configuration which looks like a completely new paragraph (in a way). Can we look into ways to make it a bit easier to follow so that Configuration part would look like it's part of the specific policy paragraph?

@erohmensing
Copy link
Contributor Author

@JustinaPetr sure, I can do that. It's happening because I decided to bold it instead of making it an actual header (as it is in the Embedding Policy) so that it wouldn't show up in the table of contents as I thought the TOC was perhaps getting a little too fleshed out. I see what you mean though by it looking like a new paragraph because of it being bigger, i'll change it to a header and see what you think.

@erohmensing
Copy link
Contributor Author

Actually, I just realized the Embedding Policy has everything tabbed in after the configuration, which makes a lot more sense. I'll try that first and see if that's enough to keep the flow

@erohmensing erohmensing merged commit d3defd0 into master Mar 15, 2019
@erohmensing erohmensing deleted the fix-policy-docs branch March 15, 2019 12:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants