-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add the Thanks page in. * Split out the developer guides for documentation and appliction to make them more distinct. * Simplify some of the Git info. * Add more cross links to appropriate sections.
- Loading branch information
Showing
8 changed files
with
155 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
.td-page-meta--child { display: none !important; } | ||
.td-page-meta--edit { display: none !important; } | ||
//.td-page-meta--edit { display: none !important; } | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: Contribute to Documentation | ||
author: Vixem Team | ||
weight: 20 | ||
description: How to contribute to the Vixen documentation. | ||
--- | ||
|
||
### Overview | ||
|
||
Vixen is an open source project and we love getting patches and contributions to make Vixen and its docs even better. | ||
|
||
This user guide is a Docsy themed site that uses the Hugo static site generator. The code for the website is hosted on [Github][5]. | ||
|
||
We welcome updates to the docs! | ||
|
||
### Updating a single page | ||
|
||
If you've just spotted something you'd like to change while using the docs, Docsy has a shortcut for you: | ||
|
||
1. Click **Edit this page** in the top right hand corner of the page. | ||
2. If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode. | ||
3. Submit a pull request to the develop branch in the repository and it will be reviewed for inclusion. | ||
|
||
### Previewing your changes locally | ||
|
||
If you want to run your own local Hugo server to preview your changes as you work: | ||
|
||
1. Follow the instructions in [Docsy Getting Started][6] to install Hugo and any other tools you need. | ||
2. Fork the [Vixen Website][5] repo into your own project, then create a local copy using `git clone`: | ||
|
||
```sh | ||
git clone git@github.com:VixenLights/web.vixenlights.com.git | ||
``` | ||
|
||
3. Change to the `web.vixenlights.com` directory and run the following Hugo command to build the site and start the Hugo server. | ||
|
||
```sh | ||
cd web.vixenlights.com | ||
npm install | ||
hugo server | ||
``` | ||
|
||
By default your site will be available at http://localhost:1313/. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site. | ||
4. Continue with the usual GitHub workflow to edit files, commit them, push the | ||
changes up to your fork, and create a pull request. | ||
### Creating an issue | ||
If there's something you'd like to see in the docs, but you're not sure how to fix it yourself, please create an [Issue][7] on Github for this repository. You can also create an issue about a specific page by clicking the **Create Documentation Issue** link in the top right hand corner of the page. | ||
|
||
[5]: https://github.com/vixenlights/web.vixenlights.com | ||
[6]: https://www.docsy.dev/docs/get-started/ | ||
[7]: https://github.com/VixenLights/web.vixenlights.com/issues/new |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: Contribute to Vixen | ||
author: Vixen Team | ||
weight: 10 | ||
description: How to contribute to the Vixen application. | ||
--- | ||
|
||
### Overview | ||
|
||
Vixen is an open source project and we love getting patches and contributions to make Vixen and its docs even better. | ||
|
||
The Vixen application code is hosted on [Github][1]. You can clone the repository to get a copy of the source code to work with. | ||
|
||
### Development Libraries | ||
|
||
There are a few libraries and tools that you need to have installed in order to get the application to build. Depending on how much you develop in other projects you may have these already installed. | ||
|
||
* Windows 10 or higher. | ||
* Visual Studio 2022 | ||
* Git | ||
* Microsoft .NET Framework 4.8 | ||
* Microsoft Visual C++ 2019 x86 Redistributable | ||
* Microsoft Visual C++ 2019 x64 Redistributable | ||
|
||
The current build target is .NET 4.8 and Visual C++ 2019, but we are actively migrating to .NET 6 and will be using Visual C++ 2022. | ||
|
||
See this [article][4] on Visual Studio settings you should use. | ||
|
||
See this [article][5] for information on Git. | ||
|
||
### Workflow | ||
|
||
When contributing to Vixen, we like to track all issues and improvements in our [JIRA bug tracker][2]. Work should have an associated issue created for it. It is a good idea to have an account in JIRA so you can work with the issues. See [Lifecycle][7] of an issue for guidance on how we manage issues. | ||
|
||
You should strive to name your branches with the ticket number. i.e. VIX-2345. Any commits to the branch should start with the ticket number as well and then follow Git guidlines for commit messages. All submissions are done through pull requests on Github. See [Branching Practices][6] for guidance on this topic. | ||
|
||
More information on how we manage JIRA can be found [here][3]. | ||
|
||
### Creating Issues | ||
|
||
Alternatively, if there's something you'd like to see in Vixen (or if you've found something that isn't working the way you'd expect), but you're not sure how to fix it yourself, please create an [Issue][2] in our JIRA board for anything in the application. | ||
|
||
[1]: https://github.com/vixenlights/vixen | ||
[2]: https://bugs.vixenlights.com | ||
[3]: {{< ref issue-management >}} | ||
[4]: {{< ref visual-studio >}} | ||
[5]: {{< ref git-information >}} | ||
[6]: {{< ref "git-information#branching-practices" >}} | ||
[7]: {{< ref "issue-management#lifecycle-of-a-ticket" >}} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.