Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
austinsonger committed Jan 23, 2025
1 parent 888ced2 commit 748d758
Show file tree
Hide file tree
Showing 6 changed files with 263 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/docs.tree
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@
<toc-element topic="running-in-terminal.md"/>
<toc-element topic="tenable-to-poam-mappings.md"/>
<toc-element topic="python-code.md"/>
<toc-element topic="Contributing-guide.md"/>
<toc-element topic="Release-notes.md"/>
</toc-element>
</instance-profile>
126 changes: 126 additions & 0 deletions docs/topics/Contributing-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Contributing guide

> If you need more information about how to fill in this template, read the accompanying [guide](https://gitlab.com/tgdp/templates/-/blob/v1.2.0/contributing-guide/guide_contributing-guide.md).
>
> This template includes writing instructions and boilerplate text that you can customize, use as-is, or completely replace with your own text. This text is indicated in {(curly brackets)}. Make sure you replace the placeholders with your own text.
## Welcome

Welcome to the {(Project Name)} Contributing Guide, and thank you for your interest.

If you would like to contribute to a specific part of the project, check out the following list of contributions that we accept and their corresponding sections that are within this guide:

* {(Contribution type 1)}
* {(Section 1)}
* {(Section 2)}
* {(Section 3)}
* {(Contribution type 2)}
* {(Section 1)}
* {(Section 2)}
* {(Section 3)}

However, at this time, we do not accept the following contributions:

* {(Contribution type 1)}
* {(Contribution type 2)}
* {(Contribution type 3)}

## {(Project Name)} overview

The purpose of the {(Project Name)} is to {(describe your project's objectives or provide an external link to an introductory document, such as the project's README file)}.

## Ground rules

Before contributing, read our {(link to the Code of Conduct)} to learn more about our community guidelines and expectations.

## Community engagement

Refer to the following channels to connect with fellow contributors or to stay up-to-date with news about the {(Project Name)}:

* Join our project contributors on {(name and link to online chat)}.
* Participate in our project meetings on {(specify the day of the week and cadence)} at {(specify time and timezone)}, where you can provide a status update or raise questions and concerns about your contributions. Use the following link to join: {(link to online meeting space)}
* Stay updated on the latest news and changes to the project by signing up to receive our newsletter. Sign up with the following link: {(link to the sign-up page for the newsletter)}

## Share ideas

To share your new ideas for the project, perform the following actions:

1. {(Step 1)}
2. {(Step 2)}
3. {(Step 3)}

## Before you start

Before you start contributing, ensure you have the following:

* {(Item 1)}
* {(Item 2)}
* {(Item 3)}

## Environment setup

To set up your environment, perform the following actions:

* {(Step 1)}
* {(Step 2)}
* {(Step 3)}

### Troubleshoot

If you encounter issues as you set up your environment, refer to the following:

* Windows: {(share a link to an external page that shares troubleshooting steps or share the procedure as sub-bullets)}
* macOS: {(share a link to an external page that shares troubleshooting steps or share the procedure as sub-bullets)}
* Linux: {(share a link to an external page that shares troubleshooting steps or share the procedure as sub-bullets)}

## Best practices

{(Option 1)} Our project has adopted the following best practices for contributing:

* {(Item 1)}
* {(Item 2)}
* {(Item 3)}

{(Option 2)} Our project uses the {(name and link to resource for best practices, such as a coding style guide or writing style guide)} as our parent guide for best practices. Reference the guide to familiarize yourself with the best practices we want contributors to follow.

## Content style guide

Read our {(name and link to your style guide)} to understand our guidelines for writing and formatting documents. The purpose of our style guide is to ensure consistency in the tone, voice, and structure of our documentation.

## Contribution workflow

### Fork and clone repositories

{(Provide instructions on how to fork and clone your repository. Alternatively, provide a link to a Git guide that explains the process.)}

### Report issues and bugs

{(Provide instructions on how to report problems.)}

### Issue management

{(Provide instructions on how to create, tag, and assign issues.)}

### Commit messages

{(Provide instructions on how to format commit messages.)}

### Branch creation

{(Provide instructions on how to create and/or name a branch.)}

### Pull requests

{(Provide instructions on how to submit a pull request. Share a link to an example pull request or include the pull request template you want contributors to use within this section.)}

### Releases

{(Provide a description of the release process and cadence for the project, such as the source code.)}

### Text formats

{(Provide information on what you need contributors to know and use to edit and create documents.)}

---

> Explore other templates from [The Good Docs Project](https://thegooddocsproject.dev/). Use our [feedback form](https://thegooddocsproject.dev/feedback/?template=Contributing%20guide) to give feedback on this template.
90 changes: 90 additions & 0 deletions docs/topics/Release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Release notes

> Thank you for downloading this template from The Good Docs Project! Before using the template, read this document to see high quality examples of the template in action and to review the resources that were consulted when this template was created. Want to explore more templates? Check them out in our [templates](https://gitlab.com/tgdp/templates) GitLab repository.
{(If you need more information about how to fill in this template, read the accompanying [Release notes process](https://gitlab.com/tgdp/templates/-/blob/v1.2.0/release-notes/process_release-notes.md) document)}

{(This template includes writing instructions and boilerplate text that you can customize, use as-is, or completely replace with your own text. This text is indicated in {curly brackets)}. Make sure you replace the placeholders with your own text.}

{(Optional: Release notes version - 0)}

{(Release date - YYYY-MM-DD)}

{(Optional: High-level summary)}

## New features

* **{(Feature name)}**

{(Feature description)}

**Example:**

* **Feature name**: We've introduced a new {(feature)} that allows users to {(benefit or function)}. This will help you {(specific use case)}.
* **Feature name**: With this release, you can now {(describe new functionality)}, giving you greater control over {(specific area)}.

## New features requiring configuration updates

* **{(Feature name)}**

{(Feature description)}

**Example:**

* **Feature name**: We've introduced a new {(feature)} that requires activating a configuration update. This feature allows users to {(benefit or function)}, improving {(specific use case)}.
* **Feature name**: With this release, you can now {(describe new functionality)}, but it requires updating your configuration settings. This gives you greater control over {(specific area)}.

## Improvements

* **{(Improvement title)}**

{(Improvement description)}

**Example:**

* **Enhanced functionality**: We've improved the speed of {(specific feature)}, reducing the time it takes to complete {(task)} by {(X%)}.
* **Improved usability**: The {(feature)} has been redesigned for easier navigation, allowing you to {(do something specific)} with fewer clicks.

## API/Web service updates

* **{(API/Web service update)}**

{(Update description)}

## Bug fixes

* **{(Bug fix title)}**

{(Bug fix description)}

**Example:**

* **Fixed issue where {(problem)}**: Resolved an issue where {(specific behavior)} caused {(impact)}. Users will now experience {(improved behavior)}.
* **Addressed crash during {(specific task)}**: A crash that occurred when {(scenario)} has been fixed, ensuring smoother operation.

### Known issues

* **{(Known issue title)}**

{(Known issue description)}

**Example:**

* **Issue name**: We are aware of an issue with {(feature)}, which may cause {(specific issue)}. Our team is actively working on a resolution, and we expect to include a fix in the next release.

## Optional: Deprecation notice

* **{(Deprecated feature name)}**

{(Deprecated feature description)}

### Examples

* **Feature name:** The {(feature name)} functionality has been deprecated as of this release. This feature will no longer be supported after {(specific date)}, as we have introduced {(alternative feature or explanation of why it's no longer needed)}. We recommend transitioning to {(alternative solution)}.
* **Outdated functionality:** Support for {(specific feature or integration)} is deprecated in this release due to {(reason, such as redundancy or incompatibility with new systems)}. For continued use, please explore {(alternative solution or updated approach)}.
* **Retired tool:** The {(tool name)} is being deprecated with this update. This tool will be phased out by {(date)}. Please migrate to {(replacement tool or workflow)}, which offers improved {(specific benefit or functionality)}.
* **API change:** The {(API endpoint name)} is deprecated as of this release. This endpoint will no longer accept requests after {(deprecation date)}. Users should update their applications to use {(new API endpoint or method)}, which supports {(enhanced functionality or feature)}.

---

> Explore other templates from [The Good Docs Project](https://gitlab.com/tgdp/templates). Use our [feedback form](https://thegooddocsproject.dev/feedback/?template=Release%20notes%20template) to give feedback on this template.
21 changes: 21 additions & 0 deletions docs/topics/python-code.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# Python Code

### Tenable Vulnerability Management Code








### Tenable Web App Scanning Code











10 changes: 9 additions & 1 deletion docs/topics/running-in-terminal.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Running in Terminal

Start typing here...









16 changes: 15 additions & 1 deletion docs/topics/tenable-to-poam-mappings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Tenable to POAM Mappings

Start typing here...

## Regular Scans to POAM






## Web App Scans to POAM






0 comments on commit 748d758

Please sign in to comment.