fix: update upgrading_an_app page for JHipster 8 #1326
Conversation
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... ;))
|
|
✅ Deploy Preview for jhipster-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
nbproject/project.properties
Outdated
| @@ -0,0 +1,3 @@ | |||
| files.encoding=UTF-8 | |||
There was a problem hiding this comment.
I know it doesn't hurt, but should the nbproject folder really under version control?
There was a problem hiding this comment.
Since I don't see other IDE meta-data, I can push a change that will ignore the whole folder.
If I may make my case, my mind was changed when I was introduced to gitignore.io's templates for IntelliJ, NetBeans, and many others. Now, I could see the logic that went into the exclusions provided by the templates. For example, .idea/codeStyle.xml was not excluded. My interest piqued and on inspection the logic made sense: you want to share the code style with your peers, not have your peers be instructed to set a style or have a commit or pipeline check "correct them."
Finally, note that.nbproject/private is excluded. IMHO there are aspects of many IDE meta-data folders that should be version controlled, but are generally excluded as a whole because determining which aspects should be excluded (ignored) and other aspects that should be included is necessarily difficult to dedicate time too. gitignore.io really changed my outlook.
There was a problem hiding this comment.
@atomfrede removed the NB meta-data and updated the exclusions.
| @@ -35,30 +35,31 @@ For this sub-generator to work you need to have `git` installed from [http://git | |||
|
|
|||
| Go into the application's root directory: | |||
|
|
|||
| `cd myapplication/` | |||
| `cd myJHipsterProject/` | |||
|
|
|||
| To upgrade your application, type: | |||
|
|
|||
| `npx jhipster upgrade` | |||
There was a problem hiding this comment.
Not sure if this is still valid from jh8 and up, as we have extracted the update/migrate into a dedicated blueprint. https://github.com/mshima/generator-jhipster-migrate
Maybe @mraible can tell more as I have never used the upgrade mechanism.
There was a problem hiding this comment.
Is this just intended to be a simple prompt that you can't perform an upgrade from an unrelated project folder? I only want to make it more explicit for semantics, myapplication ... which one of my applications?
Removed tracked NetBeans meta-data and update exclusion to nbproject folder per comments.
|
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. |
GitHub Flavored Markdown supports the use of a code fence that supplies a mermaid key. This is rendered inline. jhipster.tech may support it.
Testing a mermaid code fence... see 159e70f Removing. jhipster.tech does not render Mermaid code fences. see HEAD |
The jhipster.tech markdown parser does not render mermaid code fences. Remove test.
There was a problem hiding this comment.
- the jhipster_upgrade branch is not related to the main, you can start the line without splitting the main branch.
- each
npx jhipster upgradegenerates:
- a commit at jhipster_upgrade with the current jhipster version
- a merge commit at main (unrelated histories commit, a code equivalence) so following this merge, a commit applied to upgrade_branch will be applied as it is in main branch.
- a commit at jhipster_upgrade with the updated jhipster version.
- a merge commit at main that will apply commit 3 at main branch.
- you can split the
npx jhipster upgradecommit in 2 commits, add a merge with a different color.
There was a problem hiding this comment.
Thanks @mshima. I'll take a look at these changes. The "new graph" is mostly intended to correct the "old graph" going back to JHipster 3, and more importantly add the graph-as-code to the repository so as it does not exist in an individual's "fiddle" account (whether that individual is affiliated with JHipster or not).
|
I'd be happy to help move this along if you're still interested in helping @timothystone-knsl! |
I'm still interested @mraible |
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