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.

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

Links in dietpi-software changed from phpBB to dietpi.com/docs #4042

Merged
merged 3 commits into from
Jan 6, 2021

Conversation

StephanStS
Copy link
Collaborator

Status: Ready

@MichaIng:
Open point: The mechanism with "readonly FP_ONLINEDOC_URL='https://dietpi.com/phpbb/viewtopic.php?'" (see line 258 in dietpi-software.sh) need also to be changed to direct to dietpi.com/docs instead of phpBB.

Links were changed.

@MichaIng:
Open point: The mechanism with "readonly FP_ONLINEDOC_URL='https://dietpi.com/phpbb/viewtopic.php?'" (see line 258 in dietpi-software.sh) need also to be changed to direct to dietpi.com/docs instead of phpBB.
@StephanStS StephanStS requested a review from MichaIng January 6, 2021 12:52
@Joulinar
Copy link
Collaborator

Joulinar commented Jan 6, 2021

Open point: The mechanism with "readonly FP_ONLINEDOC_URL='https://dietpi.com/phpbb/viewtopic.php?'" (see line 258 in dietpi-software.sh) need also to be changed to direct to dietpi.com/docs instead of phpBB.

This will impact each and every software title as there is a link on each software title
aSOFTWARE_ONLINEDOC_URL[$software_id]='p=2072#p2072'

OnlineDocs are shown on command line

root@DietPi1:~# dietpi-software list |grep docker
id 162 | =0 | docker: build, ship, and run distributed applications | | https://dietpi.com/phpbb/viewtopic.php?p=9120#p9120
id 185 | =0 | portainer: simplifies container management in docker (standalone host) | | https://dietpi.com/phpbb/viewtopic.php?p=29377#p29377
root@DietPi1:~#

@MichaIng MichaIng added this to the v6.35 milestone Jan 6, 2021
@MichaIng MichaIng added the META Everything that is not code related, e.g. GitHub, Wiki, website, community label Jan 6, 2021
@MichaIng
Copy link
Owner

MichaIng commented Jan 6, 2021

What do you think:

  • Change readonly FP_ONLINEDOC_URL='https://dietpi.com/phpbb/viewtopic.php? to readonly FP_ONLINEDOC_URL='https://dietpi.com/docs/software/' and aSOFTWARE_ONLINEDOC_URL[$software_id]='p=2072#p2072' to aSOFTWARE_ONLINEDOC_URL[$software_id]='desktop/#gnustep'?
  • Or aSOFTWARE_ONLINEDOC_URL[$software_id]='https://dietpi.com/docs/software/desktop/#gnustep' and skip that prefix variable? I think, while its a few bytes more code, it's much clearer for contributors and when adding a new software title, until the new docs have been created and uploaded our side, the official website or documentation can be added instead. E.g. for most "Additional" software titles (programming languages, editors, audio/video backends, networking tools) there are currently docs missing, which could then be added.

@Joulinar
Copy link
Collaborator

Joulinar commented Jan 6, 2021

Option 2 might be more clear indeed.

+ DietPi-Software | Help prompt: Write all keyboard keys capitalised, show single "install" URL only, the "Getting started" is next in navigation and bottom next button, and tiny wording + coding.
@Joulinar Joulinar changed the title Links in dietpi-software.sh changed from phpBB to dietpi.com/docs Links in dietpi-software changed from phpBB to dietpi.com/docs Jan 6, 2021
@MichaIng
Copy link
Owner

MichaIng commented Jan 6, 2021

Are you okay with the small changes I did? I think it's okay to show one install docs URL only, the other one is the next/belog page anyway. It's a bit strange to link install documentation at a stage where DietPi has been installed already. Probably it makes more sense to link the DietPi-Software documentation itself? https://dietpi.com/docs/dietpi_tools/#dietpi-software

I also switched the software list link to point to the new docs. In most cases this shortens the way of users to the information they seek. Not sure about the future of https://dietpi.com/dietpi-software.html, if it makes sense to maintain two lists forever, but that is a different topic.

I'll open a new PR to replace the individual software docs URLs.

+ DietPi-Software | Satisfy shellcheck
@StephanStS
Copy link
Collaborator Author

StephanStS commented Jan 6, 2021

What do you think:

* Change `readonly FP_ONLINEDOC_URL='https://dietpi.com/phpbb/viewtopic.php?` to `readonly FP_ONLINEDOC_URL='https://dietpi.com/docs/software/'` and `aSOFTWARE_ONLINEDOC_URL[$software_id]='p=2072#p2072'` to `aSOFTWARE_ONLINEDOC_URL[$software_id]='desktop/#gnustep'`?

* Or `aSOFTWARE_ONLINEDOC_URL[$software_id]='https://dietpi.com/docs/software/desktop/#gnustep'` and skip that prefix variable? I think, while its a few bytes more code, it's much clearer for contributors and when adding a new software title, until the new docs have been created and uploaded our side, the official website or documentation can be added instead. E.g. for most "Additional" software titles (programming languages, editors, audio/video backends, networking tools) there are currently docs missing, which could then be added.

Like Joulinar I also prefer option 2.

@MichaIng
Copy link
Owner

MichaIng commented Jan 6, 2021

Haha, many thanks for the "bid" => "bit" fix Stephan. I often see it myself now, probably 50% of cases, but hard to wean off such a long "learned" mistake 😄.

@MichaIng MichaIng merged commit 4e6c901 into dev Jan 6, 2021
@MichaIng MichaIng deleted the StephanStS-patch-1 branch January 6, 2021 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
META Everything that is not code related, e.g. GitHub, Wiki, website, community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants