search

opencpn-manuals / plugins

Part of opencpn-manuals/main, not maintained as a separate manual
4 stars 3 forks source link

Simplify Navigation #72

Closed rgleason closed 3 years ago

rgleason commented 3 years ago

There is something funny about the navigation, I get caught in Beta Plugin Land and it is hard to get out. Also there seems to be a Beta nav.adoc that is the same as the header plugiin adoc.

I would think that conceptually we have all plugins documentation in one barrel and dip in there for the Main Plugins and the Beta Plugns, that would make it easier to move a plugin into Main and might make navigation easier.

I find there might be some room to simplify the folder and layers a bit, but I hesitate to say how as I know you guys have been working with this a lot. I am just wondering if some changes could be made to make things easier in the long run.

rgleason commented 3 years ago

Ok I will just wait for the time being, but I believe Mike expects me to do it.

This is in my MAIN branch

Rick@Dart MINGW64 ~/documents/github/OM-plugins (main)
$ git log --oneline -20
5e2c8ec (HEAD -> main, origin/main, origin/build, origin/HEAD, nav-again) [full-linkcheck] empty commit
5554a26 sources.state fixed
f74ce0d Remove extra plugins directory from manual.
702141c [full-linkcheck] empty commit
f400056 sources, site.yml: Use RooiDirk's upstream repo (#23).
d87ca47 update authoring
66bcd01 Revert to 80105f3
7382dae [full-linkcheck] empty commit
f2fc7bd Revert to 230902a
2c6aa3d [full-linkcheck] empty commit
60ab868 Revert "chnge antora back with spell error"
ac6887b [full-linkcheck] empty commit
5628d5e chnge antora back with spell error
8ef7584 Simplify Navigation -sm chngs
d2d7c63 [full-linkcheck] empty commit
230902a Simplify Navigation               <---  HERE  there are some small changes to clean up after that.   
12e9c3b [full-linkcheck] empty commit

Then in my local NAV2 branch

Rick@Dart MINGW64 ~/documents/github/OM-plugins (nav2)
$ git log --oneline -15
f6c97b4 (HEAD -> nav2) remove antora  fix managed icons
3e5d8d0 Remove managed icons
eb55097 remove commented PI
a671f37 [full-linkcheck] empty commit
98dd9d2 sml pi name correction
96ca1cb [full-linkcheck] empty commit
e137910 Simplify Maintenance                   <---- RE APPLY THIS COMMIT  and push to build and check
8ef7584 Simplify Navigation -sm chngs
d2d7c63 [full-linkcheck] empty commit
230902a Simplify Navigation       <---- RE APPLY THIS COMMIT and push to build and check
rgleason commented 3 years ago

So you want those reverts "reverted" to clean up the main branch? How would I do that without a forced push?

Rasbats commented 3 years ago

@rgleason : Yes I would like you to make those changes. I will mess it up if I do it.

rgleason commented 3 years ago

Ok Mike. I might mess up too, but will go slowly. Thanks for getting us back to something that works..

Alec, I could do a cherry pick, put my commits at the top, leaving your recent commit and mike's authoring commit, etc then make a commit, test locallly and try pushing it to build.

I will make a summary of what I could do.

rgleason commented 3 years ago

Rick@Dart MINGW64 ~/documents/github/OM-plugins (main) $ git log --oneline -20 5e2c8ec (HEAD -> main, origin/main, origin/build, origin/HEAD, nav-again) [full-linkcheck] empty commit 5554a26 sources.state fixed <--- Pick or Keep f74ce0d Remove extra plugins directory from manual. <--- Remove 702141c [full-linkcheck] empty commit <-- Remove f400056 sources, site.yml: Use RooiDirk's upstream repo (#23). <--- Pick or Keep d87ca47 update authoring <-- Pick or Keep 66bcd01 Revert to 80105f3 <-- Remove 7382dae [full-linkcheck] empty commit <-- Remove f2fc7bd Revert to 230902a <-- Remove 2c6aa3d [full-linkcheck] empty commit <-- Remove 60ab868 Revert "chnge antora back with spell error" <--Remove ac6887b [full-linkcheck] empty commit <-- Remove 5628d5e chnge antora back with spell error <--Remove 8ef7584 Simplify Navigation -sm chngs <--Remove d2d7c63 [full-linkcheck] empty commit <-- Remove 230902a Simplify Navigation <--- HERE there are some small changes to clean up after that.
12e9c3b [full-linkcheck] empty commit

I might have to change something else but will find out. Is this the right approach? First after checking everything works locally. with antora site.yml Then git push -f origin main:beta if completes do full-linkcheck Then git push origin main:main I could do a forced push but you probably would not like that

rgleason commented 3 years ago

Actually I was thinking of using interactive git squash https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History with p, pick = use commit d, drop = remove commit etc

$ git rebase -i HEAD~16

rgleason commented 3 years ago

After seeing Alex's note above and link, I will cherry pick.

git cherry-pick 230902a Which is "Simplify Navigation" <--- HERE there are some small changes to clean up after that.

It looks like this after a cleanup commit. It builds antora site.yml and I've checked all areas including authoring and they work. That worked so cleanly, I would next like to find the SHA for my "Simplify Maintenance" and use cherry-pick again.

Rick@Dart MINGW64 ~/documents/github/OM-plugins (main)
$ git log --oneline -20
9fa4f79 (HEAD -> main) two small changes rm unnecessary
61ec910 Simplify Navigation
5e2c8ec (origin/main, origin/build, origin/HEAD) [full-linkcheck] empty commit
5554a26 sources.state fixed
f74ce0d Remove extra plugins directory from manual.
702141c [full-linkcheck] empty commit
f400056 sources, site.yml: Use RooiDirk's upstream repo (#23).
d87ca47 update authoring
66bcd01 Revert to 80105f3
7382dae [full-linkcheck] empty commit
f2fc7bd Revert to 230902a
2c6aa3d [full-linkcheck] empty commit
60ab868 Revert "chnge antora back with spell error"
ac6887b [full-linkcheck] empty commit
5628d5e chnge antora back with spell error
8ef7584 Simplify Navigation -sm chngs
d2d7c63 [full-linkcheck] empty commit
230902a Simplify Navigation
rgleason commented 3 years ago

The "Simplify Maintenance" was overwritten for some reason and does not appear to be in Main branch any longer. Perhaps it was not accepted becuase by then nmeaconverter_pi had been merged and sources had changed making the "windvane" Fatal Error which signals that sources are not in sync.

I do have a commit for "Simplify Maintenance in my "nav2" branch. I am going to have to read up on how I cherry-pick that commit from another branch.

rgleason commented 3 years ago

So we need to cherry-pick
e137910 Simplify Maintenance from "nav2" branch onto "main" branch

It looks like I just need the SHA and git checkout main git cherry-pick e137910 

Rick@Dart MINGW64 ~/documents/github/OM-plugins (nav2)
$ git log --oneline -20
f6c97b4 (HEAD -> nav2) remove antora  fix managed icons
3e5d8d0 Remove managed icons
eb55097 remove commented PI
a671f37 [full-linkcheck] empty commit
98dd9d2 sml pi name correction
96ca1cb [full-linkcheck] empty commit
e137910 Simplify Maintenance   <------ Need to Cherry Pick this 
8ef7584 Simplify Navigation -sm chngs
d2d7c63 [full-linkcheck] empty commit
230902a Simplify Navigation
rgleason commented 3 years ago

So now it looks like this

Rick@Dart MINGW64 ~/documents/github/OM-plugins (main)
$ git log --oneline -10
1d1bfcd (HEAD -> main) small pi name changes
0556fce Simplify Maintenance resolve conflicts
9fa4f79 two small changes rm unnecessary
61ec910 Simplify Navigation
5e2c8ec (origin/main, origin/build, origin/HEAD) [full-linkcheck] empty commit
5554a26 sources.state fixed
f74ce0d Remove extra plugins directory from manual.
702141c [full-linkcheck] empty commit
f400056 sources, site.yml: Use RooiDirk's upstream repo (#23).
d87ca47 update authoring

and it works locally, but the build fails here

From https://github.com/opencpn-manuals/plugins
 * branch            1d1bfcdbca027d600144623b019c81c0aa0dc19b -> FETCH_HEAD
+ msg='[CI] Updating gh-pages branch from 1d1bfcdb'
+ [[ 1d1bfcd small pi name changes == *full?linkcheck* ]]
+ git commit -q -m '[CI] Updating gh-pages branch from 1d1bfcdb'
+ git push -f origin pages:gh-pages
To https://github.com/opencpn-manuals/plugins
 ! [remote rejected] pages -> gh-pages (cannot lock ref 'refs/heads/gh-pages': is at 577ba9be48e74c8e202a18756c273e4de11a7ee0 but expected e51a9103c9fff7d8bdf352bf0356aea10a4b9365)
error: failed to push some refs to 'https://github.com/opencpn-manuals/plugins'

I don't know what this problem is.

rgleason commented 3 years ago

Full Link check seems to have completed now. I am going to check sources.... later, I made a commit for new sources-state file and committed then pushed and pushed empty full-linkcheck.

rgleason commented 3 years ago

The Full-Linkcheck completed twice so I git push origin main:main.

Rick@Dart MINGW64 ~/documents/github/OM-plugins (main)
$ git log --oneline -8
0e0456a (HEAD -> main, origin/main, origin/build, origin/HEAD) [full-linkcheck] empty commit
dfa6a46 [full-linkcheck] empty commit
1d1bfcd small pi name changes
0556fce Simplify Maintenance resolve conflicts
9fa4f79 two small changes rm unnecessary
61ec910 Simplify Navigation
5e2c8ec [full-linkcheck] empty commit
5554a26 sources.state fixed

I believe it is working now. I really like git cherry-pick it is a wonderful tool. Tomorrow I will make a few changes to the Authoring page after you guys have a chance to look at it.

Rasbats commented 3 years ago

@rgleason : Rick ... Hats Off. This looks good. Updated sources.state and pushed to main/build. Generated web pages look good.

rgleason commented 3 years ago

That is great. We had success! I updated sources.state and pushed it before the second linkcheck but for some reason it did not show on build or main. Thanks very much.

May I change the diagram in authoring and add a few notes about maintenance files?

Boy is cherry pick a sweet little tool!

rgleason commented 3 years ago

Mike I tried making my changes through the Edit this page (I probably shouldnt have) but I hope they work.

https://github.com/opencpn-manuals/plugins/blob/main/manual/plugins/modules/advanced/pages/advanced.adoc