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

Guide patch #6

Merged
merged 2 commits into from Jan 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
108 changes: 1 addition & 107 deletions README.md
Expand Up @@ -7,113 +7,7 @@ Image License information can be found in Licenses sub-directory.
Port files and [Jenkins](https://jenkins.io/) integrations are stored in **port-files**.

**Tutorials and Walkthroughs:**
* [How to submit a wallpaper to Lumina themes](https://github.com/trueos/guides/tree/master/lumina-themes-submissions)
* [How to submit a wallpaper to Lumina themes](https://github.com/lumina-desktop/lumina-themes/submission_guide.md)

---

## **General Project Information: Table of Contents**

- [General TrueOS Information](#gentrosinfo)
- [TrueOS Project Documentation](#docs)
- [TrueOS Handbook](#trueosdoc)
- [Lumina Handbook](#luminadoc)
- [SysAdm Handbooks](#sysadmdoc)
- [Filing Issues or Feature Requests](#fileissues)
- [Community Channels](#community)
- [Discourse](#discourse)
- [Gitter](#gitter)
- [IRC](#irc)
- [Subreddit](#subreddit)
- [Social Media](#socialmedia)

<!-- END GENERAL INFO TOC -->

# General TrueOS Information <a name="gentrosinfo"></a>

This section describes where you can find more information about TrueOS and its related projects, file new issues on GitHub, and converse with other users or contributors to the project.

## TrueOS Project Documentation <a name="docs"></a>

A number of [Sphinx](http://www.sphinx-doc.org/en/stable/) generated reStructuredText handbooks are available to introduce you to the TrueOS, Lumina, and SysAdm projects. These handbooks are open source, and users are always encouraged to open GitHub issues or fix any errors they find in the documentation.

### TrueOS Handbook <a name="trueosdoc"></a>

The [TrueOS User Guide](https://www.trueos.org/handbook/trueos.html) is a comprehensive guide to install TrueOS, along with post-installation configuration help, recommendations for useful utilities and applications, and a help and support section containing solutions for common issues and links to community and development chat channels for uncommon issues. There is also a chapter describing the experimental TrueOS Pico project and links to the Lumina and SysAdm documentation. All TrueOS documentation is hosted on the [TrueOS website](https://www.trueos.org).

### Lumina Handbook <a name="luminadoc"></a>

The Lumina Desktop Environment has its own [handbook](https://lumina-desktop.org/handbook/), hosted on the [Lumina Website](https://lumina-desktop.org). This handbook contains brief installation instructions. However, due to the highly customizable nature of Lumina, the focus of the handbook lies mainly in documenting all user configurable settings. Each option is typically described in detail, with both text and screenshots. Finally, the suite of unique Qt5 utilities included with Lumina are also documented.

TrueOS users are encouraged to review the Lumina documentation, as the Lumina Desktop Environment is installed by default with TrueOS.

### SysAdm Handbooks <a name="sysadmdoc"></a>

Due to complexity of this project, SysAdm documentation is split into three different guides:

1. **API Reference Guide** (https://api.sysadm.us/getstarted.html)

The Application Programming Interface (API) Reference Guide is a comprehensive library of all API calls and WebSocket requests for SysAdm. In addition to documenting all SysAdm subsystems and classes, the guide provides detailed examples of requests and responses, authentication, and SSL certificate management. This guide is constantly updated, ensuring it provides accurate information at all times.

2. **Client Handbook** (https://sysadm.us/handbook/client/)

The SysAdm Client handbook documents all aspects of the SysAdm client, as well as describing of the PC-BSD system utilities is replaces. Detailed descriptions of utilities such as Appcafe, Life Preserver, and the Boot Environment Manager are contained here, as well as a general guide to using these utilities. TrueOS users are encouraged to reference this guide, as the SysAdm client is included with TrueOS.

3. **Server Handbook** (https://sysadm.us/handbook/server/introduction.html)

The Server handbook is a basic installation guide, walking new users through the process of initializing SysAdm with a bridge and server connection.

## Filing Issues or Feature Requests <a name="fileissues"></a>

Due to the number of repositories under the TrueOS "umbrella", the TrueOS Project consolidates its issue trackers into a few repositories:

* [trueos-core](https://github.com/trueos/trueos-core) : Used for general TrueOS issues, Pico issues, and feature requests.
* [lumina](https://github.com/trueos/lumina) : Issues related to using the Lumina Desktop Environment.
* [sysadm](https://github.com/trueos/sysadm) : Issues with using the SysAdm client or server.
* [trueos-docs](https://github.com/trueos/trueos-docs) : Issues related to the TrueOS Handbook.
* [lumina-docs](https://github.com/trueos/lumina-docs) : Issues related to the Lumina Handbook.
* [sysadm-docs](https://github.com/trueos/sysadm-docs) : Issues related to the SysAdm API Guide, Client, and Server Handbooks.
* [trueos-website](https://github.com/trueos/trueos-website) : Issues involving any of the TrueOS Project websites:
- https://www.lumina-desktop.org
- https://www.trueos.org
- https://www.sysadm.us

The TrueOS handbook has detailed instructions to help you report a bug (https://www.trueos.org/handbook/helpsupport.html#report-a-bug). It is recommended to refer to these instructions when creating new GitHub issues. Better bug reports usually result in faster fixes!

To request a feature, open a new issue in one of the related GitHub issue repositories and begin the title with *Feature Request:*.

## Community Channels <a name="community"></a>

The TrueOS community has a wide variety of chat channels and forum options available for users to interact with not only each other, but contributors to the project and the core development team too.

### Discourse <a name="discourse"></a>

TrueOS has a [Discourse channel](https://discourse.trueos.org/) managed concurrently with the TrueOS Subreddit. New users need to sign up with Discourse in order to create posts, but it is possible to view posts without an account.

### Gitter <a name="gitter"></a>

The TrueOS Project uses Gitter to provide real-time chat and collaboration with TrueOS users and developers. Gitter does not require an application to use, but does require a login using either an existing GitHub or Twitter account.

To access the TrueOS Gitter community, point a web browser to https://gitter.im/trueos.

Gitter also maintains a full archive of the chat history. This means lengthy conversations about hardware issues or workarounds are always available for reference. To access the Gitter archive, navigate to the desired TrueOS room’s archive. For example, here is the address of the TrueOS Lobby archive: https://gitter.im/trueos/Lobby/archives.

### IRC <a name="irc"></a>

Like many open source projects, TrueOS has an Internet Relay Chat (IRC) channel so users can chat and get help in real time. To get connected, use this information in your IRC client:

* Server name: irc.freenode.net
* Channel name: #trueos (note the # is required)

### Subreddit <a name="subreddit"></a>

The TrueOS Project also has a [Subreddit](https://www.reddit.com/r/TrueOS/) for users who prefer to use Reddit to ask questions and to search for or post how-tos. A Reddit account is not required in order to read the Subreddit, but it is necessary to create a login account to submit or comment on posts.

## Social Media <a name="socialmedia"></a>

The TrueOS Project also maintains a number of social media accounts you can watch:

* Facebook: https://www.facebook.com/groups/4210443834/
* Linkedin: http://www.linkedin.com/groups?gid=1942544
* TrueOS Blog: https://www.trueos.org/blog/
* Twitter: https://twitter.com/TrueOS_Project/

5 changes: 5 additions & 0 deletions content/Lunar-4k.license
@@ -0,0 +1,5 @@
I, JT Pennington, permit the use of the image Lunar-4k.png
as uploaded to Github repo Lumina-Themes with commit ( 02c211b )
under a CC BY-SA 4.0 License and permit unlimited
re-distribution as as a part of the Lumina-Themes Repo Package.
Full License : https://creativecommons.org/licenses/by-sa/4.0/legalcode
Binary file added content/example_license.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/fork_repo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/fork_repo_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/fork_repo_3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/get_commit_hash.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/pull_request.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/pull_request_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/pull_request_3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/upload_files.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/upload_files_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/upload_files_3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/upload_files_4.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions submission_guide.md
@@ -0,0 +1,58 @@
### Lumina Themes Wallpaper submission guide:

#### Requirements:

+ Github account
+ Photos with resolution of 3840x2160
+ Allow TrueOS to redistribute your image.

#### Steps:

+ Open the Lumina Themes repository: https://github.com/lumina-desktop/lumina-themes
+ Create a fork of the repository.

![Fork the repository](https://github.com/lumina-desktop/lumina-themes/content/fork_repo.png)
![Fork the repository](https://github.com/lumina-desktop/lumina-themes/content/fork_repo_2.png)
![Fork the repository](https://github.com/lumina-desktop/lumina-themes/content/fork_repo_3.png)


+ Navigate into the appropriate category folder for your image. If an appropriate category folder does not exist, please create it. Be aware, images may be
reorganized in the future.

+ Click "Upload Files":

![Upload](https://github.com/lumina-desktop/lumina-themes/content/upload_files.png)

+ Upload your image file:

![Upload Image](https://github.com/lumina-desktop/lumina-themes/content/upload_files_2.png)
![Upload Image](https://github.com/lumina-desktop/lumina-themes/content/upload_files_3.png)

+ Copy the commit hash:

![Copu Commit Hash](https://github.com/lumina-desktop/lumina-themes/content/get_commit_hash.png)

+ Create a License file.
+ The license is modifiable, but distribution with the “themes” package must be authorized or the project can’t use the images. Using the Creative Commons
License is recommended, but you are free to license the file as you desire. You must be the legal copyright holder to authorize us to use the photo.
+ The license file needs to include the commit hash of adding the file to the repository. Name the license file with the same name as the image. Use the
extension '.license'

> I, Ed Xample, permit the use of image “Sample-4k.png” as uploaded to Github repo Lumina-Themes with commit “<Commit Hash>” under a CC BY-SA 4.0 License and
permit unlimited-distribution as as a part of the Lumina-Themes Repository Package.
Full License : https://creativecommons.org/licenses/by-sa/4.0/legalcode


+ Upload the license file using the same process as an image:

![Uplaod License](https://github.com/lumina-desktop/lumina-themes/content/upload_files_4.png)

+ In the forked repository on GitHub, create a pull request:

![Pull Request](https://github.com/lumina-desktop/lumina-themes/content/pull_request.png)
![Pull Request](https://github.com/lumina-desktop/lumina-themes/content/pull_request_2.png)
![Pull Request](https://github.com/lumina-desktop/lumina-themes/content/pull_request_3.png)

+ Repeat these steps for every wallpaper you want to add. That's it!
+ We'll take care of the rest. If there is a problem or more information is needed, we need
anything else, we will make a comment on your Pull Request. Keep an eye on your email!