Git Product home page Git Product logo

help-center-docs's Introduction

Solus logo

Help Center documentation

This is the repository for Solus's Help Center documentation. You can help us improve the Solus experience by:

  • Contributing documentation on new topics.
  • Editing existing documentation for formatting, spelling and punctuation, and conformance with our style guide.
  • Working on fixes for existing issues.
  • Identifying and reporting new issues.

Getting started

To get started developing our Docusaurus instance, or writing documentation, first fork this project so you can submit pull requests for your changes.

This project is written using TypeScript and React, with content written in Markdown or MDX. To facilitate development, we use nvm and yarn.

Please lint and spellcheck your contributions before creating a pull request. We recommend VS Code with the "prettier" extension for linting, and Code Spell Checker (cspell) for spelling.

Content formatting and spelling

  • Writing style should follow our style guide
  • This project includes prettier for markdown and code formatting
    • Command: yarn prettier
  • This project includes Cspell for spell-checking, and has a custom wordlist .cspell-allowed-wordlist.txt
    • Command: yarn cspell
    • Note that we use American spelling
    • If you use vscode with the Code Spell Checker extension, the custom dictionary will be used
    • You can tidy the allowed-wordlist with go-task tidy-words

NVM

To set up nvm, the Node Version Manager, follow the instructions listed here. We recommend setting up their shell integration as well, so you can automatically switch to the correct Node version when working on this project. Otherwise, ensure you run nvm use. This project requires the "current" supported release series of Node.

You can validate you are using the latest by running node --version. Your version should be at least 19.x.

Yarn

This project makes use of Yarn for its package management. After setting up nvm and ensuring you are running the latest Node, run:

corepack enable

Installing dependencies

To install the required dependencies, run: yarn

Starting Docusaurus

To start the live reloading Docusaurus, run: yarn start

Other useful commands

  • Clear local build cache: yarn clear
  • Linting: yarn lint
  • Updating translation files: yarn write-translations
  • Validate build: yarn build
  • Run validated build: yarn serve

Publishing to https://help.getsol.us (via GH Pages)

Ensure that you can successfully generate a static site as above.

Then, when you're ready to deploy, run the following:

go-task deploy

This obviously assumes that you have ssh push access to the help-center-docs repository and are using [email protected]:getsolus/help-center-docs.git (as listed by git config -l).

Contributing

Multi-lingual documents

Note that multi-lingual documents are not yet supported on our Help Center. When it does, we'll be happy to accept non-English language documents.

Licenses

Build system

Files relating to the parsing / build system are licensed under GPL-2.0. For the full text, view LICENSE.txt.

Markdown

The Markdown files in this repository are licensed under the Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.

Media assets

  • Solus logo copyright and licensing information is provided on our Brand Guidelines page.
  • Non-logo assets are licensed under Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.

help-center-docs's People

Contributors

bridouz avatar datadrake avatar davidjharder avatar deoxys94 avatar der-eismann avatar drsheppard01 avatar ebonjaeger avatar ermo avatar getchoo avatar girtablulu avatar ikeydoherty avatar jacalz avatar jacekjagosz avatar joebonrichie avatar johnandmegh avatar joshstrobl avatar justinzobel avatar kyrios123 avatar livingsilver94 avatar malfisya avatar matthewscholefield avatar mcritchlow avatar neilwb avatar parkingmeter avatar reillybrogan avatar silkeh avatar staudey avatar stiat avatar sunnyflunk avatar traceyc77 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

help-center-docs's Issues

Solus Virtualbox Wiki contains bad information

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

Advice: Make the home page more readable

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.

Blu Rays Vlc

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.

Create Solus Samba HOWTO

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.

Dvorak Layout Crashes the System

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.

Add default config file location to nginx help page

Add the default nginx config file location to the documentation

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.

Hardware Additions

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.

small misspelling

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

Add steps on how to set up secondary encrypted hard drive

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.

Add new security category in the Help Center

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:

  • How to verify downloaded .iso files?
  • How to install CA certificates and import them into openconnect?
    Open up the file manager Files and click +Other Locations. Select Computer. CA certificates are then located under the following path: /etc/ssl/certs
  • How to import openVPN configuration files?
  • How to prevent DNS leaks in openVPN?
  • How to protect yourself against browser fingerprinting?
  • How to set up iptables?
  • How to encrypt your emails?
  • How to choose a reliable server for creating an XMPP account?
  • A non-technical short common sense guide to safe computing

Update Budgie-related docs and screenshots

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:

  • Changing Background configuration/changing-background/en.md
  • Configuring Date and Time configuration/configuring-date-and-time/en.md
  • Configuring Sound and Sound Devices configuration/configuring-sound-and-sound-devices/en.md
  • Enabling Desktop Icons configuration/enabling-desktop-icons/en.md
  • Enabling Workspaces 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:

  • You should be using the default theming, namely:
    • Adapta for GTK theme
    • Papirus for Icon theme
    • Breeze for Cursor Theme
    • Sections which show off specific parts of the panel should be using the default as well. If you're unsure and you're willing to drop your pinned apps, follow this doc.
  • Language should be set to English (US).
  • Minimal cropping of the image should occur and your files should be saved as JPG. If you're using GNOME Screenshot, open up GIMP and convert. Keep 100% quality, I can compress it post-merge, and refrain from over-cropping (I can always crop it further post-merge).
    • However: Refrain from taking full screen screenshots and maximizing applications.

โญ Bonus points (not necessary):

  • Add more relevant Budgie documentation based on functionality exposed in the Budgie Settings app, such as basics to Budgie and applet configuration. Budgie documentation should go in budgie/ and create screenshot folders as necessary (see other existing folders for examples).

Ordering of keys in package.yml

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.

Add verification section to Installation

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.

Add Workflow tutorial

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.

No mention about `conflicts` in the packaging documentation

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

Add information about maintainer files to Packaging documentation

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.

Improve desktop agnostic documentation

Currently, most of the articles in Configuration section assume the use of either the Budgie or GNOME Shell editions. For instance:

  • Articles that provides steps for using GNOME Control Center end up omitting MATE.
  • Enabling desktop icons assumes the use of the Budgie edition

Ideally, I'd like the articles to be tweaked to:

  • Have sections that provide instructions based on the desktop environment you use. Currently, Budgie and GNOME are mostly the same, however I'd like to have dedicated sections on MATE and eventually Plasma, once it's fleshed out by @sunnyflunk. Furthermore, with the eventuality that Budgie has its own Control Center, it'd make sense to at least "prepare" for dedicated Budgie sections as well.
    • A good example of Budgie-specific bits would be the Configuring Sound and Sound Devices section, which has information on using Raven.
    • Configuring Keyboard Layout doesn't make any note of the keyboard layout widget in Budgie nor any IBUS info.
    • I'm not sure exactly how sections should be divided up, potential ideas (any thoughts @ikeydoherty):
      • configuration/budgie/changing-backgrounds/en
      • configuration/changing-backgrounds/budgie/en
      • Dedicated sections such as Budgie, GNOME Shell, KDE / Plasma, MATE in configuration/changing-backgrounds/en

Checklist of articles that need updated

  • Common Tasks: Watching Videos
    • Needs to be updated to reflect that Budgie and GNOME editions come with GNOME MPV, whereas MATE edition comes with VLC.
  • Configuration: Changing Backgrounds
  • Configuration: Configuring Date and Time
  • Configuration: Configuring Default Applications
  • Configuration: Configuring Displays
  • Configuration: Configuring Keyboard Layout
  • Configuration: Configuring Language
  • Configuration: Configuring Mouse and Touchpad
  • Configuration: Configuring Network
  • Configuration: Configuring Sound and Sound Devices
  • Configuration: Enabling Desktop Icons
  • Configuration: Enabling Workspaces
  • Configuration: Managing Users
  • Software: GNOME Shell
    • Needs to be changed to Desktop Environments with instructions on installing:
      • Budgie with the GNOME Shell or MATE editions
      • GNOME Shell with Budgie or MATE editions
        • Ensure the lightdm / gdm instructions remain intact
      • MATE with Budgie or GNOME Shell editions

Adding tutorials and other bits from user forums

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

Add missing steps to TigerVNC doc

The TigerVNC documentation doesn't mention that the user needs to re-start the service, or what the default port is. Add this information.

Show all catagories on help center start page

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.

Developer portal link in git or arc commit messages?

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.

Which version of markdown is used in the documentation?

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.

CA certificate management or how to install root certificates

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.

  • What is a CA/root certificate and why is it important?
  • Where are CA certificates locally stored in Solus?
  • How to import CA certificates into openconnect to safeguard the VPN connection?
  • Many CA certificates cannot be installed via a web browser or a WiFi connection and in Solus you will get the message "This certificate is already installed as a certificate authority" upon clicking a .crt file in the browser when in fact it is not installed yet.

add workspaces to configuration docs?

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:

  1. how to add the workspace applet in Raven
  2. finding default Keyboard shortcuts for workspaces

I'd be happy to take a pass at this if you think this would be valuable.

Instructions for debugging?

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

Verifying 3.9999 ISO fails when performed as instructed.

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.

Adding a privat policy information

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

  • The server logs are automatically rotated, and are only HTTP access logs like any web server. They're not used for analytics and nuke themselves over time.
  • We don't collect any data.
  • We use cookies on some of the websites to make login work. Some third party mechanisms may store their own cookies (such as the antispam measures provided by Google)
  • No information is collected from your OS
  • Some applications may have their own in-built telemetry, such as Firefox. This goes to Mozilla and Solus has no involvement in it. You may also turn this off.

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 :)

Link shouldn't be there...

I noticed that on Hardware > Wireless Chipsets under Intel, the driver Intel Corporation Wireless 8265 / 8275 8086:24fd shows partly as a dead link. It shouldn't be a link at all.

screenshot from 2018-01-05 20-38-38

Improvements to Android building documentation

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

Add link to this github in "Getting Involved"

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.

Add statelessness article for packagers

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.

Enable "Last Updated"

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
Screenshot_20230521_233210

Yea or nay?

Add Printer Compatibility section to Hardware

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.

Third Party auto-update

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?

Add changing kernels section

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:

  1. What is a kernel and why would you change it?
  2. What terminal command shows the currently installed kernel?
  3. What software from the repositories can be used to display the currently installed kernel?
  4. How to change kernels via terminal commands.
  5. How to revert the changes.

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.