getsolus / help-center-docs Goto Github PK
View Code? Open in Web Editor NEWSolus's Help Center documentation as well as previous User Guide.
Home Page: https://help.getsol.us
License: GNU General Public License v2.0
Solus's Help Center documentation as well as previous User Guide.
Home Page: https://help.getsol.us
License: GNU General Public License v2.0
I just got a blu ray drive and had problems setting it up. After doing some googling I found out that i needed to install libaacs and libbdplus. Once installed from the software center, I still couldn't play my blu rays in vlc. I had to go here and download a key file and put it under ~/.config/aacs and then everything worked fine. So i thought this should be add to watching videos under the help center, because this was the first place I came to try and set everything up.
I'm not really sure if this is the right place to report bugs, but I had an issue in solus when I tried changing the keyboard layout. As soon as I deleted the English (US) layout only leaving the English (dvorak) layout the entire computer screen started flickering before it finally crashed and sent me back to the login screen. Now when I try to reboot and login it will just kick me back to the login screen after a few seconds of displaying the desktop - not to mention that the layout is still qwerty when I type in my password. Basically, it has made the entire system unusable.
I read from time to time about people complaining about Solus not having a Private Policy, I looked around and found a comment by Ikey on reddit Link
This can certainly expand and explained in detail
Dunno where something like this could be added inside the help-center-docs, so I didn't add any PR :)
Each desktop environment follows different design principles and these in turn accomodate different workflows. A workflow guide for each desktop environment could explain its central components, what default keyboard shortcuts help to navigate it and how the desktop environment is intended to be used for getting things done.
Page: https://getsol.us/articles/software/nginx/en/
Add a brief note with:
The default location for nginx config files is in /usr/share/defaults/nginx/
Copy any needed config files from here to /etc/nginx and modify as needed.
Use case: Many nginx guides and other nginx users will talk about modifying /etc/nginx/nginx.conf. Unless the user knows they can copy the default file to that location, they may not know what needs to go in it.
Could you add CTRL + P, Super + L, and ALT + F4 to the list of Budgie shortcuts?
https://solus-project.com/articles/budgie/shortcuts/en/
I think it would also be helpful to briefly mention that the Superkey is equivalent to the Windows key on many laptops.
The README.md does not specify which version of markdown is used in the Solus documentation. This could cause issues for people trying to figure out what is and is not supported.
Github markdown, for example, is quite different from standard markdown.
I think it didn't exist either on the old wiki but it would be nice to add info about updating existing packages like shown on this video.
I know this is not really an help center issue. I don't know where else I should post this suggestion.
It would be great to add a section on how to change kernels in the Configuration section: https://solus-project.com/articles/configuration/
An article could cover basics such as:
I currently have to ask via IRC because I am not sure about these issues and couldn't find any information regarding these questions in the help center.
Currently, most of the articles in Configuration section assume the use of either the Budgie or GNOME Shell editions. For instance:
Ideally, I'd like the articles to be tweaked to:
configuration/budgie/changing-backgrounds/en
configuration/changing-backgrounds/budgie/en
Budgie
, GNOME Shell
, KDE / Plasma
, MATE
in configuration/changing-backgrounds/en
Hello,
Just a friendly reminder to update some bad information contained here:
https://solus-project.com/articles/software/virtualbox/en/
#3D Acceleration
Needs to have a note that enabling 3D Acceleration is currently broken, or be removed entirely. This is a known issue with VBox w/Solus guest and a simple Google search will prove that
#USB Controller
The vboxusers group is never created, following the current instructions simply returns the error:
usermod: group 'vboxusers' does not exist
My current host OS is Windows 10 x64; I am running VBox 5.2.4 w/Ext pack; I have installed the Solus-3-Budgie ISO and am fully up-to-date on the stable channel.
Keep up the good work otherwise! <3
I would suggest to bundle a lot of security-related issues under a new security category or tag in the Help Center. The following guides could be part of it:
/etc/ssl/certs
It would be nice if the PHP integration instructions from this tutorial were integrated into the help center's HTTPD page.
Tracks #139.
The TigerVNC documentation doesn't mention that the user needs to re-start the service, or what the default port is. Add this information.
Core Team and Global Maintainers are enforcing a strict ordering of keys in package.yml, but it isn't documented in the article on package.yml. Please give clear instructions on the proper ordering of the keys so we can save iterations during the package submission process.
When I type something in the search box and I press enter, nothing happen
The current documentation on submitting an update for a package does not mention maintainer files. In particular there doesn't appear to be indicators that only the maintainers can submit a patch outside of the maintainer file itself.
I would probably suggest an addition the "Prior to Patch Submission" category found here . It is a bit frustrating to put work into a patch only to later learn that it can't be used. I understand why the core team would rather packages be updated by their maintainer but it appears to have happened a few times over the years so probably wouldn't hurt.
Could you add a verification section to Installation? I think a precise step by step guide on how to verify downloaded .iso and .sha256sum files would be very helpful. I realized that most information on verification found elsewhere is either leaving out important steps, assuming too much knowledge about the subject and ultimately leaving a less-informed user more vulnerable than an experienced one.
Hello,
As a package maintainer for Solus, I recently had to mark a package conflict between two packages. During this operation, I found that there is no mention about it in the Package.yml
page in the Help Center. This confused me a bit, and I think it confused other maintainers before.
As such, I think a new entry should be added in the optional, supported keys section, which documents the (fairly basic) usage of the conflicts
key.
If developers agree with me, then I would be very happy to submit the corresponding pull request myself!
Have a nice day,
josephscade
Maintainance in
"Packaging Practices
The primary goal of ypkg is ease of maintainence. In order to do so we ensure packages in the binary repository adhere to a strict set of conventions and practices."
should be : maintenance
Hi,
When browsing the help center I noticied that index pages for some categories are not well formatted. The ToC is embedded in <pre><code>
and thus not looking as it should.
Pages concerned are all category indexes (https://getsol.us/articles/package-management/) except for Packaging
Do you think a new Printer Compatibility section would be beneficial to be added to Hardware? I would probably look through such a list of known devices to work OOTB before making a new purchase.
First time visitors my not realize that there are more categories than what is displayed. I don't know if there is any reasoning behind this choice but I think that having it confuses newer users.
Josh has requested a Solus Help Center HOWTO detailing how the solus-specific default samba setup works.
This task tracks the status of said HOWTO.
On the page "Getting Involved" under "Report Bugs" there is only a link to the Developer Portal. There is no indication a user would report a bug anywhere else. This may lead to people filing bugs in Manphest for repos in this project.
Propose:
Add a link to this repo, add a brief note to each link.
- [Developer Portal](https://dev.getsol.us)
Most bug reports should be filed here.
- [Solus Github Repos](https://github.com/getsolus)
Certain parts of Solus, such as the Budgie Desktop, have repos on github. Check here to see if the system in question is listed. If so, file the bug in the appropriate repo.
I have a branch "report-bugs" with this minor change ready to go if the issue is approved.
Solus-3.9999-Budgie.sha256sum.sign is not a deteched signature, and in fact includes the sha256sum hash in the file. The specific command that fails is:
$ gpg --verify Solus-3.9999-Budgie.sha256sum.sign Solus-3.9999-Budgie.sha256sum
gpg: not a detached signature
The following solutions work:
Replacing the command above with:
$ gpg --verify < Solus-3.9999-Budgie.sha256sum.sign
and deprecating the use of Solus-3.9999-Budgie.sha256sum.
Or: removing the first 4 lines of Solus-3.9999-Budgie.sha256sum.sign so it does work as a detached signature. Not sure which is best practice, so I didn't want to submit a pull request.
The article "Submitting a Package" (section "Commit") seems to indicate you should put tracker tasks / etc. in the git commit message.
If you want to link this patch to an issue on the Developer portal, simply mention it in your commit message: The inclusion of fixes T1234
But these should go in the arc diff message instead.
This one always trips me up, so I end up having to switch around my git and arc messages.
The "edit this page" link on https://help.getsol.us/docs/packaging/ is 404
It goes to https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/packaging/index.md.
This is likely true for multiple pages
Dear all,
i work as a technical writer in germany and i am an avid Solus user. While reading the forums, i found out that there are many tutorials and hints in the forums.
What do you think of adding some of these things to the User Documentation?
Some examples:
Scanning forums would lead to some more posts which may be useful for allot of users.
Would be glad to contribute to Solus.
Best wishes
The current Solus installer (ISO 3.9999) only handles encryption of the primary hard drive (the one which Solus is installed on). However, in nowadays laptops it's not unusual to have two disks, a smaller SSD and a larger HDD. Normally you'd install Solus on the SSD for fast system operation and use the HDD for data storage. As said, the installer will only encrypt the SSD in this case though.
Since disk encryption is a standard feature that (IMHO) everyone should use, I'd like to propose to add a short section underneath the Disks page listing the steps needed for setting up encryption and automatic unlocking during boot for a second hard disk.
Solus tries to ship stateless packages. When upstream code is not stateless, packagers should patch the code to make it so.
We currently don't have an article explaining what statelessness really is, nor how a packager can patch code to achieve it. Stateless is part of the Solus way of doing, having one is essential.
Need to add another sudo
to the copy command call here
First time going on the site, I noticed that the home page is a little lacking in readability. For example, the popular categories are all in one column. I think the webpage could benefit from a 2 column look. Also the subtitles for the categories share the font color as the category titles. I think if the subtitles were changed to black the home page could really benefit.
Just some suggestions.
Small error I noticed. You are missing a period at the end of the packaging paragraph on this https://solus-project.com/articles/contributing/getting-involved/en/
I think it'll be important to offer a guide how to install CA/root certificates. Whether you work in a company or you need to connect to a university network, you will need to deal with installing or configuring root certificates.
https://solus-project.com/articles/software/third-party/en/:
If these instructions fail to work please file an issue. To upgrade once installed simply run the commands again. If there is a new version it will be installed.
Can we improve this paragraph? Does it mean that third party updates are installed automatically, too, or does the user have to check for third party updates manually?
Have some hardware to add the the list on help center. Don't know if desktop hardware is included, but I'll add one since the specs and internals are the same as the HP Stream netbooks of old.
HP Pavilion 300-020 - Currently running Budgie but no issues with any other version of Solus
Lenovo IdeaPad S145-15API - Currently running Plasma, but was previously running Budgie and have a Mate VM on the same machine.
I want to contribute to this project with translations in Spanish, are you interested?
Shall we maybe add instructions for people to debug their system and understand what they are actually using? Sharing some useful commands such as:
$ budgie-desktop --version
$ cat /etc/os-release
Last modified dates can be shown (and automatically updated) with the config tweak showLastUpdateTime: true,
This option does not respect the dates set in the markdown headers, but nobody likes having to change those anyway, they could be removed.
It looks like this at the bottom of each page
Yea or nay?
The game Heroes of Newerth does not support Linux anymore, so the doc detailing how to install the client is no longer needed.
https://solus-project.com/articles/packaging/release-processes/en/ says:
At minimum there shall be one sync per week - this will always on a Friday.
^
be? happen?
There is a multitude of documents that use outdated references, screenshots, instructions, etc. for Budgie (such as showing Budgie Settings in Raven as opposed to the dedicated app).
If anyone is interested in updating the documentation before I can get around to it, consider this the discussion issue and reference point for items which need to be changed, how screenshots should be taken, settings used, etc.
๐ฅ Items that need updating:
configuration/changing-background/en.md
configuration/configuring-date-and-time/en.md
configuration/configuring-sound-and-sound-devices/en.md
configuration/enabling-desktop-icons/en.md
configuration/enabling-workspaces/en.md
Note: The above referenced documents are the Markdown files and not the associated image files. The screenshots are in the respective folders in imgs/
. You may find in some documentation that only updating the screenshot is necessary, and that's perfectly okay.
โ๏ธ Screenshot specification:
โญ Bonus points (not necessary):
budgie/
and create screenshot folders as necessary (see other existing folders for examples).Shall we cover this by documenting how to install the necessary add-on and have native TB notifications on Solus?
Wondering what you all think of adding a page to the Configuration section for workspaces. Since it's not enabled by default, I think some people might find this helpful to get workspaces enabled in Budgie.
I was thinking essentially a couple screenshots and related text demonstrating:
I'd be happy to take a pass at this if you think this would be valuable.
After docker installation user(s) should be added to docker group.
sudo usermod -a -G $(whoami)
But after that, i still cannot run basic docker commands. Is there a way to inform system about changes without doing reboot or restart curernt X session (log out and log in) ?
Can be based on informations from https://docs.docker.com/engine/install/linux-postinstall/
Suggested improvements to the android build documentation:
Change
repo init -u https://android.googlesource.com/platform/manifest -b android-8.0.0_r34
to
repo init -u https://android.googlesource.com/platform/manifest -b android-8.0.0_r34 --depth 1
There is really no reason to fetch the whole commit history of Android. Fetching only the latest commit speeds up the sync by a ton and also saves a lot of space.
Change
repo sync -j `nproc` -c
To
repo sync -c --no-tags --prune
Don't use the nproc option as somebody who has a lot of cores (like 32) might trigger some sort of dos protection mechanism with this option.
I have seen this happen when cloning LineageOS from github.
All of the other changes save a bit of time and space
--no-tags don't fetch tags
--prune delete refs that no longer exist on the remote
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.