search

opencpn-manuals / plugins

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

nav-main.doc AISradar link needs fix #86

Open rgleason opened 3 years ago

rgleason commented 3 years ago

This is the correct URL for AISradar now

https://opencpn-manuals.github.io/plugins/aisradar/0.1/index.html

https://raw.githubusercontent.com/opencpn-manuals/plugins/main/manual/plugins/modules/ROOT/partials/nav-main.adoc

nav-main.doc

* AIS / Radar
** xref:ais_radar_display:ROOT:ais_radar_display.adoc[AISradar Display] image:managed_plugin.png[]
** xref:radar:ROOT:index.adoc[Radar Display] image:managed_plugin.png[]
** xref:rtlsdr::index.adoc[AIS RTL-SDR]

nav-all.doc

** xref:admiralty::index.adoc[Admiralty Tides Tables]
** xref:ais_radar_display:ROOT:ais_radar_display.adoc[AISradar Display]
** xref:autopilot-rm::index.adoc[Autopilot Raymarine]
** xref:autopilot_route::index.adoc[Autopilot Route]
rgleason commented 3 years ago

Also check this question I think it is resolved however

Why have both in sources? Nohal's should be removed, verezano is correct.

4640630...ba2df64

aisradar_pi https://github.com/nohal/aisradar_pi.git 296812e4b5b3b38d9c827527ed86360067af4f35

AISradar_pi https://github.com/Verezano/AISradar_pi.git 8628497a3b0d432a584538e92ae936e46f393ac3

Rasbats commented 3 years ago

aisradar_pi https://github.com/nohal/aisradar_pi.gi has been removed. The link in the manual should now be correct. @rgleason : If everything is ok could you close this one.

rgleason commented 3 years ago

Somehow you've undone the work I did to get this all looking better. What did you do? Perhaps that will explain what happened and what we need to do to get this so it looks right.

rgleason commented 3 years ago

This is not better, it is worse. The Dashboard manual is messed up. Edits I have made are totally missing. AISradar is incorrect, and is missing changes I made. Also Grib pi is missing a commit I made. I don't know what you have done but it is wrong.

Dashboard is titled Dashboard but in the index it is "dashboard" I had fixed all that. Now I can't find the site.yml file that had the field to fix it because you've changed where it is located and there is no longer a site.yml file for this index item as far as I can determine.

Please explain what has happened.

rgleason commented 3 years ago

Now I think you have made some structural change to the files because I can't find the source files

rgleason commented 3 years ago

Now I found it https://github.com/opencpn-manuals/main/tree/main/sources and it now supposed to remain empty. This is a difference from the structure used before.

leamas commented 3 years ago

Rick: Can you be more specific? Which changes are lost? Whch files do you not find?

There are no structural changes between your last commit 8b448ea4 and current HEAD at 4f1a8fdc

leamas commented 3 years ago

BTW: The sources directory is (and always have been) populated by ./source-state.sh restore.

leamas commented 3 years ago

Rick: Your last commit was 8b448ea4. Current HEAD is 4f1a8fdc. The diff:

$ git diff --stat HEAD 8b448ea4
 manual/plugins/modules/ROOT/partials/nav-all.adoc  |  2 +-
 manual/plugins/modules/ROOT/partials/nav-main.adoc |  2 +-
 site.yml                                           |  4 ++--
 sources.state                                      | 53 ++++++++++++++++++++++++++---------------------------
 4 files changed, 30 insertions(+), 31 deletions(-)

I. e., there is nothing like site.yml being moved around. It's just a minor edit of site.yml + a big update of sources.state

EDIT: In particular, there are no changes at all to manual/plugins/modules/ besides some minor changes to the navigation, basically updating links to match the new ais_radar_display location.

rgleason commented 3 years ago

Well, the index has changed from when I worked on it, adjusting every site.yml so that the index looked half decent. Also I know for a fact that commits I made to aisradar and grib-weather are missing.

rgleason commented 3 years ago

What is it that is used to create the index? Why has that all changed? I am reluctant to spend the time on this again untill I understand exactly how and why you are overwriting it.

Rasbats commented 3 years ago

Also I know for a fact that commits I made to aisradar

@ Verezano has not accepted your PR for the changes made to the manual.

rgleason commented 3 years ago

It looks pretty clear to me that the partials nav-all.doc and nav-main.doc and nav-beta.doc are not being used. https://github.com/opencpn-manuals/plugins/tree/main/manual/plugins/modules/ROOT/partials in the right way otherwise the index would be better.

rgleason commented 3 years ago

Now I've found this and things are starting to make better sense to me. https://github.com/opencpn-manuals/plugins/commit/f79a42392a56f6d8ccf45067d6b3a8831c382d22

I still don't understand why the index is such a mess though.

rgleason commented 3 years ago

What the xxxx happened? Now the index is looking as it should look. What changed? I would like to know so that I understand what has to be done. It was looking like a piece of ssss. Now it is as it should be.

Rasbats commented 3 years ago

One error remains in site.yml that I can see: edit_url: https://github.com/rgleason/AISradar_pi/edit/master/{path} Should be: edit_url: https://github.com/Verezano/AISradar_pi/edit/master/{path}

rgleason commented 3 years ago

Yes, that is true. When is verezano going to accept the PR? Perhaps I should just make those changes again on mine?

rgleason commented 3 years ago

So why did the index correct itself after looking like a huge mess? Was it taking time to rewrite the html for the website part?

The nav-main, nav-beta and nav-all have the index baked in basically, except when you go into a plugin document, then the index changes and starts using the site.yml parameters. So to get that index looking right we have to change parameters in the site.yml which then makes it necessary to update sources.

I did change a bunch of site.yml for various plugins, but the job is not really completed.

rgleason commented 3 years ago

And now the left index showing when you are inside a plugin document, looks right! So what exactly is going on here? It was wrong before, now all of a sudden it looks right!

rgleason commented 3 years ago

This is baffling and needs to be explained.

rgleason commented 3 years ago

Also, now the changes I made to aisradar are in place. https://opencpn-manuals.github.io/main/aisradar/0.1/index.html

Rasbats commented 3 years ago

One error remains in site.yml that I can see: edit_url: https://github.com/rgleason/AISradar_pi/edit/master/{path} Should be: edit_url: https://github.com/Verezano/AISradar_pi/edit/master/{path}

Now fixed.