Skip to content
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.

Sign up for GitHub

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

Jump to bottom

(t) Add/Update HELP icons-links to docs #2720

Closed
FroggyFlox opened this issue Oct 21, 2023 · 6 comments
Closed

(t) Add/Update HELP icons-links to docs #2720

FroggyFlox opened this issue Oct 21, 2023 · 6 comments
Assignees
@FroggyFlox
Milestone
5.1.X-X Stable re...

Comments

@FroggyFlox
Copy link
Member

In #2712, a HELP icon was added to the configuration modal header (see below):
image

Clicking this icon currently links to the documentation root but now that a dedicated documentation for the Tailscale service exists, we should point to that instead: https://rockstor.com/docs/interface/system/services.html#tailscale
@FroggyFlox
Copy link
Member Author

@phillxnet, actually... while we're at it: would you be OK with adding this HELP icon/link to all services that have a section in our docs at https://rockstor.com/docs/interface/system/services.html?
We might as well do that in one swoop so that we have some consistency throughout services.

@phillxnet
Copy link
Member

@FroggyFlox That would be great.

@FroggyFlox FroggyFlox self-assigned this Oct 21, 2023
@FroggyFlox FroggyFlox changed the title (t) Update HELP button link to Tailscale docs (t) Add/Update HELP icons-links to docs Oct 21, 2023
@FroggyFlox
Copy link
Member Author

FroggyFlox commented Oct 21, 2023 •
edited
Loading

The services needing updating would thus be:

FroggyFlox added a commit to FroggyFlox/rockstor-core that referenced this issue Oct 21, 2023
@FroggyFlox
Add/Update help icon linking to docs rockstor#2720
fcdb18e 
In the configuration modals for our Services, some include links to
their respective docs while other do not.

This commit harmonizes these discrepancies by adding the same help icon
linking to the Service's section in our docs.
Also includes:
  - minor update of Tailscale service configuration header so that it
    matches the other services
  - update copyright statements
@FroggyFlox FroggyFlox mentioned this issue Oct 21, 2023
Closed
@FroggyFlox
Copy link
Member Author

Some services need new sections in our docs: see rockstor/rockstor-doc#460 for details.

@FroggyFlox
Copy link
Member Author

I'll update #2721 once rockstor/rockstor-doc#462 is merged.

FroggyFlox added a commit to FroggyFlox/rockstor-core that referenced this issue Oct 24, 2023
@FroggyFlox
Add missing help icons-links to do docs rockstor#2720
6e5b5aa 
Some configurable services were still missing a help icon-link because
they did not have a dedicated section in the docs.

Since rockstor/rockstor-doc#462, all services
have a doc section so this commit adds these missing help icons-links.
FroggyFlox added a commit to FroggyFlox/rockstor-core that referenced this issue Oct 25, 2023
@FroggyFlox
Add/Update help icon linking to docs rockstor#2720
6b47e8e 
In the configuration modals for our Services, some include links to
their respective docs while other do not.

This commit harmonizes these discrepancies by adding the same help icon
linking to the Service's section in our docs.
Also includes:
  - minor update of Tailscale service configuration header so that it
    matches the other services
  - update copyright statements
@FroggyFlox FroggyFlox mentioned this issue Oct 25, 2023
Merged
@phillxnet phillxnet added this to the 5.1.X-X Stable release milestone Nov 24, 2023
phillxnet added a commit that referenced this issue Nov 28, 2023
@phillxnet
Merge pull request #2725 from FroggyFlox/2720_Add-Update-HELP-icons-l…
5fa419e 
…inks-to-docs

Add/Update help icon linking to docs #2720
@phillxnet
Copy link
Member

Closing as:
Fixed by #2725
by @FroggyFlox

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@FroggyFlox FroggyFlox

Labels
None yet
Projects
None yet
Milestone
5.1.X-X Stable release
Development

No branches or pull requests
2 participants
@phillxnet @FroggyFlox