Puppy documentation needs updated or replaced

[williwaw]

IMO the right solution is to do exactly what @user1234 is doing right now: clean up rootfs-skeleton/usr/share/doc by removing irrelevant (like the intro to regular expression) or misleading documentation that doesn't work, modernizing things a bit (i.e. Inkscape vs. Sodipodi), and making some documentation optional (for example, removing pmusic documentation if pmusic is not included in the build, or providing ConnMan-specific documentation instead of SNS-specific documentation in a build with ConnMan).

Fair enough,

And Puppy overall (not just documentation), do you have any suggestions how someone with minimal coding skills can best contribute?

[dimkr]

You can try to fix a bug, then submit a pull request. If you need something trivial to start with, https://github.com/puppylinux-woof-CE/w ... ssues/2800, https://github.com/puppylinux-woof-CE/w ... ssues/2883 and https://github.com/puppylinux-woof-CE/w ... ssues/2847 are good examples.

Other than that, Puppy is a do-ocracy: you can develop new features, build icon themes ... whatever you enjoy doing.

[user1234]

I have update release-skeleton.bottom.htm. Nothing much to change, just the links have been updated:-

release-skeleton.bottom.htm.tar.bz2

(1.23 KiB) Downloaded 42 times

@bigpup and @williwaw, please review.

[bigpup]

Looks good to me.

I am not sure this is really needed.
It actually started when there was a really detailed flow chart of Puppy Linux development and releases.
That link; See Puppy Linux Family Tree, would take you to this flow chart.
But that flow chart is so out of date now.

Well, here is the flow chart
https://puppylinux-woof-ce.github.io/family-tree.html

I do wonder how this list is going to be updated.

I do not think it is really needed.

[user1234]

Looks good to me.

I am not sure this is really needed.
It actually started when there was a really detailed flow chart of Puppy Linux development and releases.
That link; See Puppy Linux Family Tree, would take you to this flow chart.
But that flow chart is so out of date now.

Well, here is the flow chart
https://puppylinux-woof-ce.github.io/family-tree.html

I do wonder how this list is going to be updated.

I do not think it is really needed.

The flow chart link is not needed or the releases file is not needed?

[williwaw]

re: index.html.bottom and making a pull request

I am slowly familiarizing myself with git hub and how to proceed with editing index.html.bottom
https://docs.github.com/en/pull-request ... ll-request

Note: To open a pull request in a public repository, you must have write access to the head or the source branch or, for organization-owned repositories, you must be a member of the organization that owns the repository to open a pull request.

presuming I can follow the preliminary steps needed to make a pull request, there still remains the need for the acquisition of write access. My making a request such as this to woof-ce seems excessive, as those with write access must also be trusted? And a request such as this should not be made lightly or given freely?

[user1234]

re: index.html.bottom and making a pull request

I am slowly familiarizing myself with git hub and how to proceed with editing index.html.bottom
https://docs.github.com/en/pull-request ... ll-request

Note: To open a pull request in a public repository, you must have write access to the head or the source branch or, for organization-owned repositories, you must be a member of the organization that owns the repository to open a pull request.

presuming I can follow the preliminary steps needed to make a pull request, there still remains the need for the acquisition of write access. My making a request such as this to woof-ce seems excessive, as those with write access must also be trusted? And a request such as this should not be made lightly or given freely?

You need not have write access for making a PR. Read access is necessary to accept the PR. One with write access can directly push to woof-CE. One with read access can approve PRs, which can then be later on merged by a woof-CE member with write access.

As long as I know, currently dimkr and 01micko have write access, who themselves have made large contributions.

[bigpup]

The flow chart link is not needed or the releases file is not needed?

For sure the link to the flow chart is not needed. It is providing outdated info.

I am not really sure what the releases file is really used for.
Not sure what or if anything is still using it.

The lists of Puppy versions is outdated.
So i would delete them.

I guess it could provide a link to the Puppy download page of puppylinux.com

A link to the Puppy forum Mainline Puppy Linux Distros
viewforum.php?f=114

[williwaw]

thanks user1234
I suppose we are not working directly in the woof-ce repo so the best procedure for a contributor to woof-ce is somewhat different from what most tutorials show?

Can anyone link to a tutorial for making a PR that is relevant for this situation?

[dimkr]

As long as I know, currently dimkr and 01micko have write access, who themselves have made large contributions.

I focus on dpup-specific changes, mostly around the area of Wayland support. In the last month or so, I'm also working on making pTheme optional, to benefit dpup and the potential release of FossaPup 9.6. Some changes are big, but affect only dpup.

Generally, if I'm unsure, I'm waiting for somebody else to review changes that affect any woof-CE build and not just dpup, before I merge them. Most of the time it takes for me to add a new woof-CE features is spent on minimizing changes and making sure woof-CE doesn't change anything for @peebee (and yes, sometimes I miss and break something).

This is also why I'm not using my merge rights to merge the documentation changes right now, before this PR gets approval from other woof-CE users.

Can anyone link to a tutorial for making a PR that is relevant for this situation?

https://github.com/puppylinux-woof-CE/w ... ibutor-101

[williwaw]

Can anyone link to a tutorial for making a PR that is relevant for this situation?

https://github.com/puppylinux-woof-CE/w ... ibutor-101

still learning, maybe someone can help. I am following the tutorial,
step 4 open an editor --ok
step 5 create a branch-- I dont have the same options in the dropdown. I right clicked on tab to get the dropdown.

capture20752.png (197.59 KiB) Viewed 1056 times

perhaps the default editor is configured different from the tutorial?

I can create a branch from the main page (not within the editor), but don't know if there is a way to make the editor open in the branch
Tx

[user1234]

Can anyone link to a tutorial for making a PR that is relevant for this situation?

https://github.com/puppylinux-woof-CE/w ... ibutor-101

still learning, maybe someone can help. I am following the tutorial,
step 4 open an editor --ok
step 5 create a branch-- I dont have the same options in the dropdown. I right clicked on tab to get the dropdown.capture20752.png

perhaps the default editor is configured different from the tutorial?

I can create a branch from the main page (not within the editor), but don't know if there is a way to make the editor open in the branch
Tx

See at the bottom-left, there is written Github and in its right, testing. testing is your current branch. You can change branches by clicking on it, I suppose.

EDIT: Yes, you could do that like that. I'd update the tutorial image once I open up my laptop. Thanks for pointing out!

EDIT: @williwaw, I have updated the image. Take a look once again at https://github.com/puppylinux-woof-CE/w ... ibutor-101.

[williwaw]

thanks 1234

BTW, found that you can create a branch before you open the editor by clicking on the button in the upper left of your repo.
after the branch has been created one can switch to it before opening the editor, then changing the URL from .com to .dev to bring the editor up in the branch

[user1234]

thanks 1234

BTW, found that you can create a branch before you open the editor by clicking on the button in the upper left of your repo.
after the branch has been created one can switch to it before opening the editor, then changing the URL from .com to .dev to bring the editor up in the branch

Of course you could. There are so many ways, you know. You could even install vs-code locally and then use it to set-up github things, which of course does not provide all of the features that Github provides, very similar to github.dev.

Since this is just a quick start to modifying woof-CE, and not a tutorial for github, hence the tutorial needs not contain all of the methods.

[user1234]

@bigpup, Pheonix-Starlight answered my question on github about the PPD file. Here is link to his answer:- https://github.com/puppylinux-woof-CE/w ... 1352422244.

He answers it giving link to this wikipedia page:- https://en.m.wikipedia.org/wiki/PostScr ... escription. Will you please modify the printing documentation with the above given link. Instead of the example file, point the user to that link. Or otherwise copy the example from that link and create new file.... Meanwhile you could also do other modifications to the same file.

Thanks

[bigpup]

Here is the edited cups_shell.htm

I kept the example of where the driver file is usually placed in Puppy Linux file system.

Added the link to the Wikipedia page explaining the driver .ppd file.
.

cups_shell.htm.zip

(1.81 KiB) Downloaded 24 times

Not sure at the time I installed a printer driver I really needed to know what was in the driver.ppd file and exactly what it did.
It was more about knowing I needed one to get the printer to work.
But the edit does provide useful info.

Thanks for that wikipedia link

Note:
Not sure how that .ppd file name got looking like a link to something.
But I think my edit got it back to just being a name.

[user1234]

Here is the edited cups_shell.htm

I kept the example of where the driver file is usually placed in Puppy Linux file system.

Added the link to the Wikipedia page explaining the driver .ppd file.
.
cups_shell.htm.zip

Not sure at the time I installed a printer driver I really needed to know what was in the driver.ppd file and exactly what it did.
It was more about knowing I needed one to get the printer to work.
But the edit does provide useful info.

Thanks for that wikipedia link

Note:
Not sure how that .ppd file name got looking like a link to something.
But I think my edit got it back to just being a name.

I'll check it later on. Thanks!

[user1234]

@bigpup, I have updated your cups_shell.htm with a bit more information. Here is the file:-

cups_shell.htm.tar.gz

(1.8 KiB) Downloaded 40 times

Please review.

[bigpup]

Two manufacturers with excellent support for Linux are Brother and Hewlett Packard, and Puppy enthusiasts have created PET packages for them. These can be found on the Puppy Linux forum and some of the specific Puppy versions' repositories.

that link: Puppy Linux forum is not working.

Unless you know specifically where any printer drivers are in the Puppy repositories.
That link is not going to provide anything.
I looked in several of the different Puppy version pet directories and found no printer driver pets.

I think the Puppy forum Driver section of additional Software is only place anyone puts driver pets.

I know you edited trying to give more details, but sometimes it is best to keep the info simple and short.

Eyes glassing over is always a concern for people reading help and info stuff.

Links at bottom of page do look better and seem to all work.

I think the example of where to put a driver .ppd file needs to be in this.
That will be the first question.
Where in Puppies file system does it go?
I know the link to the PostScript Printer Description (PPD) files tells about the .ppd location for Cups.
But that assumes they will actually read it and all of it.

[user1234]

that link: Puppy Linux forum is not working.

It opens forums.htm. Before I edited it, it pointed the user to forum.puppylinux.com, so I thought it would be great to first bring the user to forums.htm. So I think it might be great to leave the link as is, unless you say you like it to be forums.puppylinux.com .

BTW, one of the links at the bottom give link to the driver section of this forum.

I think the example of where to put a driver .ppd file needs to be in this.
That will be the first question.
Where in Puppies file system does it go?
I know the link to the PostScript Printer Description (PPD) files tells about the .ppd location for Cups.
But that assumes they will actually read it and all of it.

I'll do the requested. Thanks!

[user1234]

@bigpup, I have updated the file. Please review.

cups_shell.htm.tar.gz

(1.84 KiB) Downloaded 41 times

[bigpup]

Under drivers you still have a link to the Puppy repository.

There are no printer drivers in the different Puppy version directories.
No one puts printer drivers in these directories.

So that is bad info to tell someone they can look for drivers there.

These can be found on the Puppy Linux forum
That link going to the forums.htm is not the Puppy forum, but a page showing different Puppy forums.
To me it needs to be deleted or go to the forum.puppylinux.com.
Taking someone to a page giving links to other locations is just confusing.

Putting a link to forums.htm at the bottom with the other links would be a good idea.

[user1234]

@bigpup, well I got a bit late this time . Just a bit of change was required. Here is the file again:-

cups_shell.htm.tar.bz2

(2.21 KiB) Downloaded 40 times

[bigpup]

You got it!

That one looks good!

Good work

[user1234]

I have started with the HOWTO-multimedia.htm today. Seems like it needs the most amount of modifications required. I also am going to undertake documentation for bdrv (don't think it needs to be very big, just that the user knows that apt is present on their system and PPM is hence unusable for installing ubuntu/debian packages). I'll post that file as well here. I'll add it to the build system instead of adding it to the rootfs-skeleton, so that it may be copied only when bdrv is built (we could do just that with woof-code/support/bdrv.sh ). These are all my current plans.

[bigpup]

Do you have a close to completely updated doc directory, that could be suggested to put into F96 Puppy, that is about to be the next new release of Puppy?
viewtopic.php?t=7678

Even if it still needs tweaking, it would be better than the old outdated doc directory, we are working on.

[williwaw]

is HOWTO-multimedia.htm the last of the files that need updating in the docs?
@bigpup
is the work list on the first page up to date?

[user1234]

(Post deleted)

[user1234]

Do you have a close to completely updated doc directory, that could be suggested to put into F96 Puppy, that is about to be the next new release of Puppy?
viewtopic.php?t=7678

Even if it still needs tweaking, it would be better than the old outdated doc directory, we are working on.

Of course. If you want it, I could send you the whole directory. There are still few ones which need update.

BTW, I closed the draft PR I had earlier. Please read https://github.com/puppylinux-woof-CE/w ... 1366645799. I'll reopen next PR to woof-CE when I complete with all docs.

One more thing to note, the connman-gtk and sns helps are present in their respective petbuild and package directory. So, if the docs will be updated manually, then we'll need to put either of those manually as well (depending on which one does F96 use).

EDIT: Here is the github branch which has all my docs update:- https://github.com/lakshayrohila/woof-CE/tree/docs/main. If @rockedge wants, then I could open up a PR to his woof-CE fork.

BTW, is F96 built with fossa ubuntu repos, or jammy ubuntu repos?

is HOWTO-multimedia.htm the last of the files that need updating in the docs?

Well, no. There is samba_printing.htm and maybe some other as well. I'll inform you later on which ones need to be updated.

EDIT: Files to be updated:-

• HOWTO_dialup.htm (In case puppy still supports dialup connections) [this file has been renamed from HOWTO_modem.htm]

• HOWTO-multimedia.htm

• Pudd.htm

• samba-printing.htm

• HOWTO-internationalization.htm

[user1234]

@bigpup, @williwaw, I've updated HOWTO-multimedia.htm. Please review.

HOWTO-multimedia.htm.tar.bz2

(5.16 KiB) Downloaded 42 times