Skip to content

Put live documentation on fleetdm.com#1380

Merged
mikermcneil merged 72 commits intomainfrom
compile-docs-all-the-way
Aug 18, 2021
Merged

Put live documentation on fleetdm.com#1380
mikermcneil merged 72 commits intomainfrom
compile-docs-all-the-way

Conversation

@mikermcneil
Copy link
Copy Markdown
Member

@mikermcneil mikermcneil commented Jul 14, 2021

  • Finishes markdown compilation
  • Adjusts HTML/CSS to work with compiled markdown
  • Completes the MVP version of docs, minus some of the bells and whistles like search (for now)
  • Closes Fleet documentation on fleetdm.com #706

It works like this now:
image
image

@mikermcneil mikermcneil self-assigned this Jul 14, 2021
@mikermcneil mikermcneil mentioned this pull request Jul 14, 2021
10 tasks
@gillespi314
Copy link
Copy Markdown
Contributor

gillespi314 commented Jul 14, 2021

FYI the partials generated by the script seem to play nicely with the template. Here's what a page looks like with just some quick styling of the h1-h4 tags:

Screen Shot 2021-07-14 at 6 10 39 PM

Of course we'll pretty things up more once MM is done with this PR but just wanted to give y'all a quick preview.

@gillespi314
Copy link
Copy Markdown
Contributor

^^ Obv the nav menus are just placeholders. Are we thinking that the page controller will extract the nav menu items by parsing the html of partial?

@gillespi314
Copy link
Copy Markdown
Contributor

gillespi314 commented Aug 12, 2021

Is it possible to wrap each section (not just the ones pictured) in a div or section tag, so that we can give them all a consistent 40px spacing between each?

@mike-j-thomas, the best way I can think to do this given the limitations of the markdown -> html process would be to manually conform the headings levels in the GitHub markdown documentation and then apply the desired padding-top in the CSS so that you get the look you want when it all compiles. Since we just now navigating this, there's lots of inconsistency in how the docs are marked up on GitHub that needs to be sorted out. Perhaps you and I can sync up for a Zoom where we can go through each of the current doc pages and figure out how we want to conform things? I think it would be well worth our time to spend an hour or so to look at everything together in one pass.

@gillespi314
Copy link
Copy Markdown
Contributor

Are these headers red because they are pulling in the tag from the markdown? Let's ignore them for now to avoid more delays and tackle them later?

Yep, that is what's going on here. We could fix these up too if/when we schedule a Zoom.

@mike-j-thomas
Copy link
Copy Markdown
Member

mike-j-thomas commented Aug 13, 2021

This is looking really good, thanks @gillespi314.

The following is what's outstanding for style/consistency, but I think we can make the docs live and tackle these later:

  • Red text ( I think this is all code tags from the markdown. Would be ideal if these could have the same grey code styling as the code blocks. They look like links at the moment.
  • Inconsistent code blocks. Some are grey, some are black. I like the grey ones.
  • Some TLC for the parent pages of each section. Specifically the large vibrant blue (clickable) headers. @mike-j-thomas to think about a better solution.
  • Section spacing. @gillespi314, your proposal above sounds good. Let's schedule a quick call.

@mike-j-thomas
Copy link
Copy Markdown
Member

mike-j-thomas commented Aug 13, 2021

The problem specifically with the REST API page is a parasails thing and something I'll fix:

Cannot load page script (`forgot-password) because a page script has already been loaded on this page.

image

  • TODO: mikermcneil fix it

@mikermcneil are we waiting on this before we can merge?

Added a parasails-has-no-page-script attribute to the docs template, added a check for that attribute in parasails.js and removed the empty page script for 498

</div>

<div purpose="content" id="body-content" class="d-flex flex-column p-0 px-lg-5 content">
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@eashaw thank you! FYI this is related to mikermcneil/parasails#4

@mikermcneil
Copy link
Copy Markdown
Member Author

mikermcneil commented Aug 17, 2021

Here's what's left that I'm aware of for this PR:

  • @mikermcneil implement redirect in view-basic-documentation (tracked elsewhere)
  • @mikermcneil tweak how sitemap.xml is generated so it doesn't pretend handbook pages are there
  • @gillespi314 whatever of the style tweaks above that you'd like to see in before we ship this
  • @gillespi314 delete the no-longer used view-documentation and view-docs-template and the files for their page scripts, LESS files, and HTML (and importer.less entries)
  • Hide search

image

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.

Fleet documentation on fleetdm.com

4 participants