Skip to content

Commit 5026877

Browse files
authored
Update readme (#3)
Update ReadMe
1 parent 86726fd commit 5026877

File tree

3 files changed

+53
-5
lines changed

3 files changed

+53
-5
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
11
# Oracle SQL Features
22

3-
## Building
3+
## Contributing
4+
5+
To contribute a feature to this page, add a new [AsciiDoc](https://asciidoc.org/) (`*.adoc`)
6+
file into the `features` folder.
7+
You can find an AsciiDoc template `feature.adoctemplate` in the `features` folder.
8+
9+
AsciiDoc files can be organized into subfolders.
10+
11+
For more information about the AsciiDoc syntax, see the [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/).
12+
13+
## Building the website locally
14+
15+
It is encouraged to build the website locally first before pushing to GitHub to
16+
detect rendering issues or typos before the changes go live.
17+
18+
### Dependencies
419

520
1. Install Antora as explained at https://docs.antora.org/antora/latest/install-and-run-quickstart/
6-
2. Refresh navigation files by invoking
21+
22+
### Build
23+
24+
1. Refresh navigation files by invoking
725
```shell
826
$ sh .github/scripts/generate-navigation.sh
927
```
10-
3. Generate the site using the `local-playbook.yml` file
28+
1. Generate the site using the `local-playbook.yml` file
1129
```sh
1230
$ antora local-playbook.yml
1331
```
14-
4. Inspect the generated site at `build/site/index.html`
32+
1. Inspect the generated site at `build/site/index.html`

features/feature.adoctemplate

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
= ###Feature Name###
2+
:database-version: ###Database version###
3+
:database-category: ###Category###
4+
5+
Replace this text with a brief feature description.
6+
7+
8+
[source,sql]
9+
[subs="verbatim"]
10+
----
11+
###Put your SQL syntax here###
12+
----
13+
14+
.Result
15+
[source,sql]
16+
[subs="verbatim"]
17+
----
18+
###Put an example of the SQL syntax here (syntax and output)###
19+
----
20+
21+
== Benefits
22+
23+
Replace this text with the benefits the feature provides
24+
25+
== Further information
26+
27+
* Introduced: xref:versions:{database-version}/index.adoc[]
28+
* Availability: ###Oracle Database feature edition availability, use "all editions" if it is not factored###
29+
* link:###URL Link to the Doc###[Documentation]
30+
* link:###URL Link to an example###[Example]

features/plsql-function-in-sql.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ SELECT capitalize(name) as name, capitalize(get_domain_name(url)) AS domain_name
4646
FROM products;
4747
----
4848

49+
.Result
4950
[source,sql]
5051
[subs="verbatim"]
51-
.Result
5252
----
5353
SQL> WITH
5454
2 -- Function to capitalize input string

0 commit comments

Comments
 (0)