Merge branch 'master' into DOCS-2576-patch5

truenas · Oct 21, 2021 · 68dcb44 · 68dcb44
2 parents ab94146 + 284169d
commit 68dcb44
Show file tree

Hide file tree

Showing 19 changed files with 182 additions and 197 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -2,7 +2,7 @@
 # Unless a later match takes precedence, #global-owner1 and
 # #global-owner2 will be requested for review when someone opens a pull
 # request.
-* @mrt134 @q5sys @BonnieF @jervin777 @tonyriv3 @ericbsd
+* @mrt134 @q5sys @BonnieF @jervin777 @tonyriv3 @ericbsd @MicJ
 # Order is important; the last matching pattern takes the most
 # precedence. When someone opens a pull request that only
 # modifies JS files, only #js-owner and not the global

diff --git a/content/CORE/GettingStarted/Install.md b/content/CORE/GettingStarted/Install.md
@@ -7,6 +7,11 @@ weight: 10
 
 Now that the <file>.iso</file> file is [downloaded](https://www.truenas.com/download-truenas-core/), you can start installing TrueNAS!
 
+{{< expand "Major Upgrades" "v" >}}
+The install process can be repeated with newer installation files when the system already has TrueNAS installed.
+This is used for [major version upgrades]({{< relref "MajorUpgrade.md" >}})
+{{< /expand >}}
+
 {{< expand "ISO Verification" "v" >}}
 The iXsystems Security Team cryptographically signs TrueNAS ISO files so that users can verify the integrity of their downloaded file.
 This section demonstrates how to verify an ISO file using the [Pretty Good Privacy (PGP)](https://tools.ietf.org/html/rfc4880) and [SHA256](https://tools.ietf.org/html/rfc6234) methods.
@@ -71,8 +76,9 @@ If you're still researching what kind of hardware to use with TrueNAS, read over
 
 ## Prepare the Install File
 
-Physical hardware requires burning the TrueNAS installer to a device, typically a CD or removable USB device.
-This device is temporarily attached to the system to install TrueNAS to the system's permanent boot device.
+Physical hardware typically requires burning the TrueNAS installer to a physical device. In general a CD or removable USB device is used. This device is temporarily attached to the system to install TrueNAS to the system's permanent boot device.
+
+Headless, or remote, installation is possible when the system has IPMI available and can create a virtual media CD-ROM using a locally stored <file>.iso</file>.
 
 The method of writing the installer to a device varies between operating systems.
 Click **Windows** or **Linux** to see instructions for your Operating System, or **CD** for generic CD burning guidance.
@@ -104,10 +110,26 @@ Be very careful when using dd, as choosing the wrong *of=* device path can resul
 Enter `dd status=progress if=path/to/.iso of=path/to/USB` in the CLI.
 If this results in a “permission denied” error, use `sudo dd` with the same parameters and enter the administrator password.
 {{< /expand >}}
+
+{{< expand "Headless Install" "v" >}}
+Systems with IPMI connectivity, like the TrueNAS Mini, can use the Virtual Media feature with an <file>.iso</file> to create a virtual boot device for installation.
+Mounting the <file>.iso</file> in a virtual CD-ROM, allows installing or updating headless servers remotely through the console.
+
+Here is an example of setting up a virtual CD-ROM with a SUPERMICRO IPMI:
+
+1. From the **Virtual Media** menu, select *CD-ROM Image*.
+2. Fill in the details:
+   1. **Shared Host**: The IP address of the system storing the <file>.iso</file>.
+   2. **Path to Image**: The path to the image file. Example: *install/iso/SCALEAngelfish.iso*
+3. Click **Mount**.
+4. Click **Refresh Status** and confirm a disk is being emulated.
+5. Click **Save**.
+{{< /expand >}}
+
 ## Install Process
 
 With the installer added to a device, you can now install TrueNAS onto the desired system.
-Insert the install media and reboot or boot the system.
+Insert the install media, or load the iso using IPMI, and reboot or boot the system.
 At the motherboard splash screen, use the hotkey defined by your motherboard manufacturer to boot into the motherboard UEFI/BIOS.
 
 Choose to boot in UEFI mode or legacy CSM/BIOS mode.
@@ -280,4 +302,4 @@ CLick *Add* and create a new tunable with the *Variable* `if_vmx_load`, *Value*
 
 Congratulations, TrueNAS is now installed!
 
-The next step is to log in to the web interface and begin [storing data]({{< relref "StoringData.md" >}}).
+The next step is to [log in to the web interface]({{< relref "LoggingIn.md" >}}) and begin configuring the system.
diff --git a/content/Contributing/IssueReporting/BugsFeatures.md b/content/Contributing/IssueReporting/BugsFeatures.md
diff --git a/content/Contributing/IssueReporting/Debug.md b/content/Contributing/IssueReporting/Debug.md
diff --git a/content/Contributing/IssueReporting/SaveWebConsoleLog.md b/content/Contributing/IssueReporting/SaveWebConsoleLog.md
diff --git a/content/Contributing/IssueReporting/_index.md b/content/Contributing/IssueReporting/_index.md
@@ -1,5 +1,144 @@
 ---
 title: "Issue Reporting"
-geekdocCollapseSection: true
 weight: 10
----
+aliases:
+  - /contributing/issuereporting/bugsfeatures/
+  - /contributing/issuereporting/debug/
+  - /contributing/issuereporting/savewebconsolelog/
+---
+
+We encourage all users to help us make TrueNAS the best NAS by reporting issues, requesting potentially helpful features, and relaying security vulnerabilities.  
+
+{{< tabs "Issue Reporting" >}}
+{{< tab "Bugs and Features" >}}
+iXsystems uses [Jira](https://www.atlassian.com/software/jira) to track bugs and develop features.
+You can view public issues without logging in, but you must create a Jira account to report bugs or suggest features.
+
+![TrueNAS Jira Project](/images/Contribute/Jira.png "TrueNAS Jira Project")
+
+## Bug Reports
+
+Go to the [TrueNAS project on Jira](https://jira.ixsystems.com/browse/NAS) and click *Create* in the top bar.
+
+![Create Ticket](/images/Contribute/JiraCreate.png "Create Ticket")
+
+Set the *Issue Type* to *Bug*. The form will reload with more fields.
+Developers use most of them, but you should fill out the *Summary* and *Description* to provide a useable report.
+
+The *Summary* is a short, descriptive title that helps developers find the issue and understand the topic.
+
+The *Description* lets you enter specific issue details.
+
+![JiraSummaryDescription](/images/Contribute/JiraSummaryDescription.png "Summary and Description Field")
+
+A good bug report includes these elements:
+
+* A "to the point" description detailing the problem you encountered.
+
+* Steps to reproduce the issue. A simple list of the steps you took to see the issue is fine.
+
+* An explaination of what should have happened while taking the steps listed above.
+
+* A description of what actually happened while taking the steps listed above.
+
+* Your TrueNAS software version (found in **Dashboard**).
+
+* If the bug is service-related, include the current service configuration to help developers replicate your system.
+
+* Always include a TrueNAS Debug file. Include a console log if the error is a web interface issue.
+  If unsure how to save these, refer to the TrueNAS Debug and Web Console Log tabs on this page.
+
+* Include screenshots if the bug is a web interface glitch or a formatting problem.
+
+* Include a video if screenshots do not adequately show the issue.
+
+* Include additional details you think can help the developer investigate.
+
+When finished filling out the *Description*, click *Create* at the bottom of the form.
+
+![Submit Ticket](/images/Contribute/JiraCreateBottom.png "Submit Ticket")
+
+Developers will review and update the ticket if/when they need additional information.
+The Jira account receives emails about the ticket status.
+Developers may request more details as they work to resolve the issue, so check the ticket periodically.
+
+## Feature Suggestions
+
+{{< include file="static/includes/General/CreateJiraSuggestion.md.part" markdown="true" >}}
+
+## Security Issues
+
+We publish previous security reports at https://security.truenas.com/.
+
+Security issues do not appear on public issue trackers due to their sensitive nature.
+If you have discovered a suspected security vulnerability in the latest version of a software release, you can [report this directly to the Security Team](mailto:[email protected]).
+{{< /tab >}}
+
+{{< tab "TrueNAS Debug" >}}
+## Creating a Debug File
+
+{{< include file="static/includes/CORE/CreateDebug.md.part" markdown="true" >}}
+
+## Adding a Debug File to a Report
+
+Jira provides a secure area for uploading files with sensitive information like a system debug.
+
+### New Tickets
+
+Drag and drop the file into the **Private Attachment** box:
+
+![JiraAttachmentNew](/images/Contribute/JiraAttachmentNew.png "NAS Project Bug Creation Form")
+
+Clicking *browse* opens a local system file browser for selecting files.
+
+### Existing Tickets
+
+Open the ticket in your browser and find the **Attachments** section.
+
+![JiraAttachmentExisting](/images/Contribute/JiraAttachmentExisting.png "Jira Ticket: Private Attachments")
+
+Click the *+* to open a dialog for adding a new file to the secure area.
+
+![JiraNASAttachPrivateDialog](/images/Contribute/JiraNASAttachPrivateDialog.png "Attaching a private file")
+
+Drag and drop the file, add any comments about it, then click *Attach*.
+
+Uploads in the **Private** section are only visible to project developers. JIRA removes them when closing the ticket.
+{{< /tab >}}
+
+{{< tab "Web Console Log" >}}
+## Web Console Log
+Web console logs help diagnose problems with the user interface.
+You can add logs to TrueNAS issues for debugging.
+
+### Firefox
+
+Open the web console by clicking <i class="fa fa-bars" aria-hidden="true" title="Menu"></i> **(Menu) > More Tools > Web Developer Tools** (<kbd>Ctrl-Shift-I</kbd>).
+
+In the upper right, set *Persist Logs*.
+Click <i class="fa fa-bars" aria-hidden="true" title="More"></i> (More) > Settings. In the Web Console section, set **Enable timestamps**. 
+
+Select the *Console* tab, then click <i class="fa fa-cog" aria-hidden="true" title="Settings"></i> (Settings) and set *Show Timestamps* and *Persist Logs*.
+
+Leave the console open and perform the action that encounters problems.
+Right-click in the console window and select *Export Visible Messages To > Clipboard*.
+Open an editor, paste the clipboard contents, and save to a new <file>console.log</file> file.
+
+After saving the file, open the console with <i class="fa fa-bars" aria-hidden="true" title="Menu"></i> **(Menu) > More Tools > Web Developer Tools** (<kbd>Ctrl-Shift-I</kbd>) and unset *Persist Logs*.
+
+### Chrome
+
+Open the console by clicking <i class="fa fa-ellipsis-v" aria-hidden="true" title="Options"></i> **(Options) > More Tools > Developer tools** (<kbd>Ctrl-Shift-I</kbd>).
+
+Click <i class="fa fa-cog" aria-hidden="true" title="Settings"></i> **(Preferences)** and set *Preserve log* and *Show timestamps*. Close the **Preferences** window.
+
+Leave the console open and perform the action that encounters problems. Right-click the console window. Choose *Save as…* and save the file.
+
+After saving the file, open the console with <i class="fa fa-ellipsis-v" aria-hidden="true" title="Options"></i> **(Options) > More Tools > Developer tools** (<kbd>Ctrl-Shift-I</kbd>) and unset *Preserve log*.
+
+## Attaching a Console Log File to a Report
+
+Go to the [iXsystems Bug Tracker](https://jira.ixsystems.com). Locate an existing ticket or create a new one reporting the problem.
+Attach the console log file to the ticket by dragging it to **Attachments**.
+{{< /tab >}}
+{{< /tabs >}}
diff --git a/content/SCALE/_index.md b/content/SCALE/_index.md
@@ -43,5 +43,3 @@ Deploy a single hyperconverged node in a home/office or a cluster with hundreds
 With support for KVM VMs, Kubernetes, and Docker containers, it’s easy to add applications to suit your every need.
 {{< /tab >}}
 {{< /tabs >}}
-
-<img src="https://www.truenas.com/wp-content/uploads/2020/11/TrueNAS_SCALE_Software_Features_Data_Sheet_2020_image-scaled.jpg">