-
Notifications
You must be signed in to change notification settings - Fork 277
DOC-5131 first attempt at links/formatting for develop landing page #1567
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
Conversation
|
GAH! Thank you for catching my mistake, @andy-stark-redis. I've a PR that fixes this up now. Apologies for introducing merge conflicts for this PR! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I'm always polite. 🙂 Aren't I? 🥺
- I like the content and image selection. I think it's just the right amount. Michelle might have other ideas though. 😉
- Rather than using an entirely new layout to exclude the right side TOC, I'm wondering if you could instead use a bit of frontmatter, say
hideTOC: trueto hide the TOC as appropriate for each_index.mdpage. It would work just like thehideListLinksfrontmatter. It would also be easier for other folks to use that way, though they would have to make the same changes to theoperatelist layout as shown below.
{{ if not .Params.hideTOC }}
{{ partial "docs-toc.html" . }}
{{ end }}
- The images don't show in preview (but they do locally 🤔). You might consider using the
imageshortcode; it's used very widely in the K8s, RC, and RS docs. - If you don't intend on reusing the content elsewhere, I think it's better to "inline" the content currently stored in the two shortcodes. Or maybe consider using embeds, but only if you intend to reuse that content.
Feel free to reach out via Slack if you want to discuss.
|
@dwdougherty Thanks for the review! In response:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can leave the content shortcodes for now. As for the rest, it looks good. I'll go ahead and approve, but please don't merge until @mich-elle-luna weighs in.
"It was that uncouth ne'er-do-well @mich-elle-luna I was concerned about." LOL! There was art in that sentiment. :)
|
It's weird that it doesn't show a merge conflict. As it stands now, were you to merge this PR, it would overwrite a change I made last night to the develop list.html layout. |
@dwdougherty I resolved the merge conflict earlier. |
|
The file still shows the old test: The test should be:
Maybe I just don't understand Git/GitHub. I blame dotage. :( |
layouts/develop/list.html
Outdated
| {{ if strings.HasSuffix .RelPermalink "/develop/" }} | ||
| <div class="overflow-x-auto"> | ||
| <table class="w-full border-collapse md:table"> | ||
| <table class="w-full border-collapse md:table" style="background-color: rgb(240,240,240)"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please change this line to the following to stick with Tailwind CSS styling.
<table class="w-full border-collapse md:table bg-neutral-150">
BTW, I like the background for this page element; really makes it pop!
|
I think this is looking really nice! I might suggest that the screenshots for insight and vscode appear in a larger size to break up the page a bit more and highlight those UIs, but I think this is a great update to start with and see how it goes. Thank you! |
mich-elle-luna
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you!
|
One final comment: Do you know why the three columns of the last table are not spread out evenly on the page? This is triggering my OCD! 😂 |
|
I'm not sure if the table column width issue is connected, but the footer should appear all the way across the page. Right now, it is stuck on the right side and needs to be fixed before merging. |
mich-elle-luna
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure where the problem is, but the footer in the preview is not appearing all the way across the page.
| <table> | ||
| <tr> | ||
| <td> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove these three lines, which cause the footer to behave erratically.
layouts/shortcodes/dev-features.html
Outdated
| </tr> | ||
| <tr> | ||
| <td> | ||
| <ul style="list-style-type: none; padding-left:0%;margin-left:-2%"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please replace styling with this Tailwind CSS class:
class="list-none pl-0 -ml-[2%]"
Same for the other instances further down.
|
The first three lines of the |
|
@dwdougherty Thanks for your new @mich-elle-luna David's updates fix the footer issue now and also the two screenshots are now a bit bigger. See what you think. |
dwdougherty
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LG(reat)TM!
|
@dwdougherty I think we've made a good joint effort here :-) Let's see if @mich-elle-luna has any further suggestions, and if we're all happy then we can merge. |
mich-elle-luna
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you!
DOC-5131
I've added a table for the client and tool links and thrown in a few speculative formatting ideas. Also, I've tried removing the page ToC bar from the right-hand side.
BTW, this also fixes something I didn't notice on the previous PR - all section index pages using the list.html layout had the CLI widget at the top (ie, index pages for data types, client APIs, etc). Maybe we should leave that in, actually - I don't know.
Anyway, all (polite) feedback welcome :-)