-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from Sonichigo/v2-docs
V2 docs
- Loading branch information
Showing
66 changed files
with
1,823 additions
and
288 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
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
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,39 @@ | ||
| /* "Copy" code block button */ | ||
| pre { | ||
| position: relative; | ||
| } | ||
|
|
||
| pre .btnIcon { | ||
| position: absolute; | ||
| top: 4px; | ||
| z-index: 2; | ||
| cursor: pointer; | ||
| border: 1px solid transparent; | ||
| padding: 0; | ||
| color: #fff; | ||
| background-color: transparent; | ||
| height: 30px; | ||
| transition: all .25s ease-out; | ||
| } | ||
|
|
||
| pre .btnIcon:hover { | ||
| text-decoration: none; | ||
| } | ||
|
|
||
| .btnIcon__body { | ||
| align-items: center; | ||
| display: flex; | ||
| } | ||
|
|
||
| .btnIcon svg { | ||
| fill: currentColor; | ||
| margin-right: .4em; | ||
| } | ||
|
|
||
| .btnIcon__label { | ||
| font-size: 11px; | ||
| } | ||
|
|
||
| .btnClipboard { | ||
| right: 10px; | ||
| } |
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,48 @@ | ||
| // Turn off ESLint for this file because it's sent down to users as-is. | ||
| /* eslint-disable */ | ||
| window.addEventListener('load', function() { | ||
| function button(label, ariaLabel, icon, className) { | ||
| const btn = document.createElement('button'); | ||
| btn.classList.add('btnIcon', className); | ||
| btn.setAttribute('type', 'button'); | ||
| btn.setAttribute('aria-label', ariaLabel); | ||
| btn.innerHTML = | ||
| '<div class="btnIcon__body">' + | ||
| icon + | ||
| '<strong class="btnIcon__label">' + | ||
| label + | ||
| '</strong>' + | ||
| '</div>'; | ||
| return btn; | ||
| } | ||
|
|
||
| function addButtons(codeBlockSelector, btn) { | ||
| document.querySelectorAll(codeBlockSelector).forEach(function(code) { | ||
| code.parentNode.appendChild(btn.cloneNode(true)); | ||
| }); | ||
| } | ||
|
|
||
| const copyIcon = | ||
| '<svg width="12" height="12" viewBox="340 364 14 15" xmlns="http://www.w3.org/2000/svg"><path fill="currentColor" d="M342 375.974h4v.998h-4v-.998zm5-5.987h-5v.998h5v-.998zm2 2.994v-1.995l-3 2.993 3 2.994v-1.996h5v-1.995h-5zm-4.5-.997H342v.998h2.5v-.997zm-2.5 2.993h2.5v-.998H342v.998zm9 .998h1v1.996c-.016.28-.11.514-.297.702-.187.187-.422.28-.703.296h-10c-.547 0-1-.452-1-.998v-10.976c0-.546.453-.998 1-.998h3c0-1.107.89-1.996 2-1.996 1.11 0 2 .89 2 1.996h3c.547 0 1 .452 1 .998v4.99h-1v-2.995h-10v8.98h10v-1.996zm-9-7.983h8c0-.544-.453-.996-1-.996h-1c-.547 0-1-.453-1-.998 0-.546-.453-.998-1-.998-.547 0-1 .452-1 .998 0 .545-.453.998-1 .998h-1c-.547 0-1 .452-1 .997z" fill-rule="evenodd"/></svg>'; | ||
|
|
||
| addButtons( | ||
| '.hljs', | ||
| button('Copy', 'Copy code to clipboard', copyIcon, 'btnClipboard'), | ||
| ); | ||
|
|
||
| const clipboard = new ClipboardJS('.btnClipboard', { | ||
| target: function(trigger) { | ||
| return trigger.parentNode.querySelector('code'); | ||
| }, | ||
| }); | ||
|
|
||
| clipboard.on('success', function(event) { | ||
| event.clearSelection(); | ||
| const textEl = event.trigger.querySelector('.btnIcon__label'); | ||
| textEl.textContent = 'Copied'; | ||
| setTimeout(function() { | ||
| textEl.textContent = 'Copy'; | ||
| }, 2000); | ||
| }); | ||
| }); | ||
|
|
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
13 changes: 13 additions & 0 deletions
13
versioned_docs/version-1.0.0/concepts/reference/glossary.md
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,13 @@ | ||
| --- | ||
| id: glossary | ||
| title: Glossary for Users | ||
| sidebar_label: Glossary | ||
| description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. | ||
| tags: | ||
| - explanation | ||
| keywords: | ||
| - API | ||
| --- | ||
|
|
||
| 1. [Acceptance Testing](/docs/concepts/reference/glossary/acceptance-testing) | ||
| 2. [Agile Unit Testing](/docs/concepts/reference/glossary/agile-unit-testing) |
32 changes: 32 additions & 0 deletions
32
versioned_docs/version-1.0.0/concepts/reference/glossary/acceptance-testing.md
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,32 @@ | ||
| --- | ||
| id: acceptance-testing | ||
| title: Acceptance Testing | ||
| sidebar_label: Acceptance Testing | ||
| description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. | ||
| tags: | ||
| - explanation | ||
| keywords: | ||
| - API | ||
| --- | ||
|
|
||
| ### What is Acceptance Testing? | ||
|
|
||
| Acceptance testing (AT) is a formal testing process that is conducted to determine whether a software system meets the requirements of the customer or end user. AT is the last phase of software testing, and it is conducted after all other levels of testing have been completed. | ||
|
|
||
| The purpose of AT is to ensure that the software system is acceptable to the customer or end user. This means that the system must meet the customer's or end user's needs and expectations. AT also helps to identify any defects or problems with the software system that may have been missed during earlier phases of testing. | ||
|
|
||
| ### Acceptance Testing Types: | ||
|
|
||
| - **User acceptance testing (UAT)**: This is the most common type of AT. It involves the customer or end user using the software system in a way that simulates how they will use it in the real world. | ||
| - **Systematic testing**: This involves using a set of predetermined test cases to test the software system. | ||
| - **Acceptance test-driven development (ATDD)**: This is a technique that combines AT with test-driven development (TDD). TDD is a software development process that involves writing unit tests before the code is written. ATDD extends TDD by adding acceptance tests to the mix. | ||
|
|
||
| ### Benefits of Acceptance Testing: | ||
|
|
||
| - It helps to ensure that the software system meets the needs and expectations of the customer or end user. | ||
| - It helps to identify any defects or problems with the software system that may have been missed during earlier phases of testing. | ||
| - It helps to improve the overall quality of the software system. | ||
| - It helps to reduce the risk of defects and problems with the software system. | ||
| - It helps to ensure that the software system is ready for release. | ||
|
|
||
| Acceptance testing is vital in ensuring software meets stakeholder demands and quality standards. |
36 changes: 36 additions & 0 deletions
36
versioned_docs/version-1.0.0/concepts/reference/glossary/agile-testing.md
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,36 @@ | ||
| --- | ||
| id: agile-unit-testing | ||
| title: Agile Unit Testing | ||
| sidebar_label: Agile Unit Testing | ||
| description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. | ||
| tags: | ||
| - explanation | ||
| keywords: | ||
| - API | ||
| --- | ||
|
|
||
| Agile unit testing is a software testing process that is used in agile development teams. It involves writing small, self-contained tests that verify the behavior of individual units of code. These tests are typically written by the developers themselves, and they are run frequently throughout the development process. | ||
|
|
||
| ### Why is agile unit testing important? | ||
|
|
||
| Agile unit testing is important because it can help to improve the quality of software applications. By finding and fixing defects early, agile unit testing can help to prevent bugs from reaching production, which can save time and money. | ||
|
|
||
| ### How does agile unit testing work? | ||
|
|
||
| Agile unit testing is typically done by developers. Developers write unit tests that verify the behavior of individual units of code. These unit tests are then run automatically as part of the development process. | ||
|
|
||
| ### What are the benefits of agile unit testing? | ||
|
|
||
| 1. It helps to ensure the quality of the code by catching bugs early in the development process. | ||
| 2. It can help to improve the maintainability of the code by making it easier to track changes and to identify regressions. | ||
| 3. It can help to speed up the development process by reducing the amount of time that is spent debugging. | ||
|
|
||
| ### Key Principles of agile unit testing: | ||
|
|
||
| 1. **Test-driven development (TDD)**: TDD is a development methodology that involves writing unit tests before writing the code. This helps to ensure that the code is designed with testing in mind, and it can help to improve the quality of the code. | ||
| 2. **Continuous integration (CI)**: CI is a process that involves automating the build and testing of software. This helps to ensure that the code is always in a releasable state, and it can help to catch bugs early in the development process. | ||
| 3. **Continuous delivery (CD)**: CD is a process that involves automating the deployment of software. This helps to ensure that the software is always available to users, and it can help to improve the speed of deployment. | ||
|
|
||
| ### Conclusion | ||
|
|
||
| Agile unit testing is a valuable tool for improving the quality of software applications. By following the best practices for agile unit testing, developers can help to ensure that their applications are free of defects and meet the needs of their users. |
Oops, something went wrong.