fix: update upgrading_an_app page for JHipster 8 #1326
Conversation
|
|
✅ Deploy Preview for jhipster-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Regarding my public gist for the Git graph. It's more stable than the JSFiddle that is currently provided, read: it doesn't work. @atomfrede I think it's probably prudent to fork or replicate my Gist to the JHipster organization or member, or commit it as part of this repository. I didn't find an appropriate place for it off hand. |
Testing a mermaid code fence... see 159e70f Removing. jhipster.tech does not render Mermaid code fences. see HEAD |
|
I'd be happy to help move this along if you're still interested in helping @timothystone-knsl! |
I'm still interested @mraible |
|
@timothystone Can you please fix conflicts if this page still needs to be updated? I tried using the current page to update my jhipster8-demo app last night and it worked flawlessly! |
timothystone
force-pushed
the
docs/jhipster-upgrade
branch
from
bb760f1
to
559ed62
Compare
Resolved conflicts and pushed, then realized I should not have rebased (as a rule)... hope that hasn't cause anyone any headaches. |
|
We updated the website with a new design. Can you please update this issue accordingly? |
Done. Still owe you a high resolution image. |
Done and Done. added the raw mermaid file to the static resources to move away from user accounts on GitHub and JSFiddle. The code is in the repository. Squashed the commits. |
Use Font Awesome's Level Up Glyph over the "refresh" glyph, for semantics. Use Markdown friendly Headers and Header links over HTML. Fix the options available since JHipster 8. Use Markdown syntax fences and link to updated Git Graph image (using Mermaid) and provide more stable path for editing with GitHub public Gist. Standardize on the use of asterisks over mixed dash|asterisk unordered Markdown lists. docs: correct Markdown header link and tighten up image of upgrade Use the generated image from Mermaid for the git graph. hyphens in headers are converted to literals, resulting in a "triple-dash" in the resulting link. docs: test a mermaid code fence in jhipster.tech GitHub Flavored Markdown supports the use of a code fence that supplies a mermaid key. This is rendered inline. jhipster.tech may support it. docs: remove mermaid code fence The jhipster.tech markdown parser does not render mermaid code fences. Remove test. docs: add hi-resolution git graph example and mermaid file Update the image resolution. Add the mermaid file for retention vs. user gist or fiddle account.
timothystone
force-pushed
the
docs/jhipster-upgrade
branch
from
c29a691
to
b0f2f60
Compare
|
Is it possible to make the graphical view image clickable so a reader can zoom in? I'm on an iPad and the font is a little small. |
Depends on what kind of lightbox support docusaurus has built-in. I'll poke around. How do you feel about the PR including feature enhancements to the site? Lightbox support is "[best] implemented as a first-party plugin.". This would meet the request. I could also just make it a link to a "new page." 🤔 💭 I could potentially use a different theme—just catching up on customization of the theme in Mermaid, like using the JHipster colors and increasing the font-sizes. Updated image...
|
|
@mraible asking @mshima to review the image. Marcelo asked upthread for some nuance and I'm trying to bend Mermaid to my will. 🧜♀️ |
timothystone
force-pushed
the
docs/jhipster-upgrade
branch
2 times, most recently
from
c0054a0
to
9279187
Compare
|
@mraible Without added functionality, i.e., a lightbox, I can't get the image to link to open in a new window or page. 🙁 |
|
Can't you just link to the image file? That should only require good ol' HTML. |
Tried that. The image didn't render... something to do with docusaurus? I'm going to push a version with the lightbox, just in case you want to consider it. |
Add link to image (test) and update image and raw mermaid file. Add flexanalytics/plugin-image-zoom for image lightbox.
timothystone
force-pushed
the
docs/jhipster-upgrade
branch
from
9279187
to
3d55c0f
Compare
|
I must say I like that... looking on my iPad... looks good. |
|
@mraible the plugin does effect all images in the site. I did configure Docusaurus to allow for image exclusion though. |
|
@timothystone Looks good! I'm on vacation for the long weekend and only looked at the preview on my phone. If someone can give a more thorough review/merge, please do! |
|
Thanks @timothystone, great work |
Use Font Awesome's Level Up Glyph over the "refresh" glyph, for semantics.
Use Markdown friendly Headers and Header links over HTML.
Fix the options available since JHipster 8.
Use Markdown syntax fences and link to updated Git Graph image (using Mermaid) and provide more stable path for editing with GitHub public Gist.
Standardize on the use of asterisks over mixed dash|asterisk unordered Markdown lists.
Add NetBeans ignore option (yes, we are still out here... ;))
Fixes jhipster/generator-jhipster#24588