Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 412e002

Browse files
committed
Moving authors.md and CONTRIBUTING.md to docs/about, so they are included in html docs.
Updated project details Updated mkdocs.yml - new pages added Updated readme.md with new links
1 parent 0c57f09 commit 412e002

5 files changed

Lines changed: 18 additions & 14 deletions

File tree

File renamed without changes.
File renamed without changes.

docs/about/project-details.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99
utPLSQL is hosted on [hosted on GitHub](https://github.com/utPLSQL/utPLSQL) and open source project.
1010

11-
Community help on this project is always appreciated, if your interested in helping please read our [guide to contributing](https://github.com/utPLSQL/utPLSQL/blob/master/CONTRIBUTING.md)
11+
Community help on this project is always appreciated, if your interested in helping please read our [guide to contributing](CONTRIBUTING.md)
1212

1313

1414

15-

mkdocs.yml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
site_name: utPLSQL
55
site_description: utPLSQL Documenation Powerful Unit Testing Framework for Oracle PL/SQL
66
copyright: Copyright © 2016 - utPLSQL Team
7-
repo_url: https://github.com/utplsql/utplsql/
7+
repo_url: https://github.com/utPLSQL/utPLSQL
88
theme: mkdocs
99
use_directory_urls: false
1010
strict: true
@@ -16,9 +16,16 @@ pages:
1616
- Getting Started: userguide/getting-started.md
1717
- Annotations: userguide/annotations.md
1818
- Expectations: userguide/expectations.md
19-
- Testing Best Pracitces: userguide/best-practices.md
20-
- Upgrade utPLSQL : userguide/upgrade.md
19+
- Running unit tests: userguide/running-unit-tests.md
20+
- Testing best pracitces: userguide/best-practices.md
21+
- Upgrade utPLSQL: userguide/upgrade.md
22+
- Reporting:
23+
- Using reporters: userguide/reporters.md
24+
- Reporting errors: userguide/exception-reporting.md
25+
- Code coverage: userguide/coverage.md
2126
- About:
2227
- Project Details: about/project-details.md
2328
- License: about/license.md
2429
- Support: about/support.md
30+
- Authors: about/authors.md
31+
- Contributing: about/CONTRIBUTING.md

readme.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ __Download__
4343

4444
Published releases are available for download on the [utPLSQL GitHub Releases Page.](https://github.com/utPLSQL/utPLSQL/releases)
4545

46+
[__Authors__](docs/about/authors.md)
4647

4748
__Version 2 to Version 3 Comparison__
4849

@@ -194,19 +195,16 @@ c:\my_work\>sqlplus /nolog @ut_run hr/hr@xe
194195
Will run all the suites in the current schema (hr) and provide documentation report into screen.
195196
Invoking this script will show the progress after each test.
196197

198+
# Contributing to the project
197199

198-
__Primary Directories__
200+
Community help on is always appreciated, if your interested in helping please read our [guide to contributing](docs/about/CONTRIBUTING.md)
201+
202+
__Project Directories__
199203

200204
* .travis - contains files needed for travis-ci integration
201205
* client_source - Sources to be used on the client-side. Developer workstation or CI platform to run the tests.
202206
* development - Set of useful scripts and utilities for development and debugging of utPLSQL
203-
* docs - Markdown version of the documentation
207+
* docs/md - Markdown version of the documentation
204208
* examples - contains example unit tests.
205209
* source - contains the installation code for utPLSQL
206-
* tests - contains the tests written to test utPLSQL
207-
208-
209-
210-
211-
212-
210+
* tests - contains the tests for utPLSQL framework

0 commit comments

Comments
 (0)