From 2f22a7e0925e60ee94424e7d348aa569c966cf70 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Tue, 25 Jan 2022 11:29:37 +0100 Subject: [PATCH] docs --- SECURITY.md | 6 +- docs/.router.php | 19 + docs/Dockerfile | 27 + docs/Makefile | 47 +- docs/docker-compose.yml | 9 + docs/v0.0/index.html | 11 + docs/v0.0/ion.html | 23 + docs/v0.0/ion.stub.php | 1108 +++++++++++++++++++++++++++++ docs/v0.0/ion/: Contributing.html | 140 ++++ docs/v0.0/ion/: Security.html | 135 ++++ docs/v0.0/ion/Catalog.html | 4 + docs/v0.0/ion/Catalog/add.html | 4 - docs/v0.0/ion/Decimal.html | 4 + docs/v0.0/ion/Exception.html | 4 + docs/v0.0/ion/LOB.html | 4 + docs/v0.0/ion/Reader.html | 4 + docs/v0.0/ion/Serializer.html | 4 + docs/v0.0/ion/Symbol.html | 4 + docs/v0.0/ion/Timestamp.html | 4 + docs/v0.0/ion/Type.html | 4 + docs/v0.0/ion/Unserializer.html | 4 + docs/v0.0/ion/Writer.html | 4 + docs/v0.0/ion/serialize.html | 4 + docs/v0.0/ion/unserialize.html | 4 + package.xml | 1 + 25 files changed, 1560 insertions(+), 22 deletions(-) create mode 100644 docs/.router.php create mode 100644 docs/Dockerfile create mode 100644 docs/docker-compose.yml create mode 100644 docs/v0.0/ion.stub.php create mode 100644 docs/v0.0/ion/: Contributing.html create mode 100644 docs/v0.0/ion/: Security.html diff --git a/SECURITY.md b/SECURITY.md index 4ceb40d..5f02e54 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,9 +5,9 @@ This project is still in its early development stages, so please consider any release not explicitly labeled as stable as experimental. -| Version | Supported | -| ------- | ------------------ | -| 0.x | :white_check_mark: | +| Version | Supported | +| ------- | --------- | +| 0.x | ✓ | ## Reporting a Vulnerability diff --git a/docs/.router.php b/docs/.router.php new file mode 100644 index 0000000..9287598 --- /dev/null +++ b/docs/.router.php @@ -0,0 +1,19 @@ +/dev/null) +TAG := $(shell (git describe --tags --exact-match --match=v[1-9]* 2>/dev/null || echo v0.0) | cut -d. -f-2) + +# --- + +SPECIAL_SRC := src/ion/\\\:\\\ Security.md src/ion/\\\:\\\ Contributing.md src/ion.md .PHONY: all all: latest -.PHONY: clean -clean: - -rm -rf latest src vendor composer.* +latest: $(TAG) + -unlink $@ 2>/dev/null + ln -s "$(TAG)/" $@ + touch $@ + +$(TAG): markdown | vendor/bin/ref2html + mkdir -p $@ + $(PHP) $| $@ src + touch $@ + +.PHONY: markdown +markdown: src/ion.stub.php $(SPECIAL_SRC) | vendor/bin/stub2ref + $(PHP) $| ion $< src + +src src/ion: + -mkdir -p $@ +src/ion.stub.php: ../ion.stub.php | src + -test -e $@ || ln $^ $@ +src/ion.md: ../README.md | src + -test -e $@ || ln $^ $@ +src/ion/\\\:\\\ Security.md: ../SECURITY.md | src/ion + -test -e $@ || ln $^ $@ +src/ion/\\\:\\\ Contributing.md: ../CONTRIBUTING.md | src/ion + -test -e $@ || ln $^ $@ vendor/%: $(COMPOSER) require m6w6/mdref:dev-master -src: ../ion.stub.php | vendor/bin/stub2ref - mkdir -p $@ && cd $@ && $(PHP) ../$| ion ../$^ - touch $@ +.PHONY: clean +clean: + -rm -rf latest src vendor composer.* -$(TAG): src | vendor/bin/ref2html - mkdir -p $@ - $(PHP) $| $@ $^ - touch $@ -latest: $(TAG) - -unlink latest 2>/dev/null - ln -s "$(TAG)/" latest - touch $@ diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml new file mode 100644 index 0000000..3a481f0 --- /dev/null +++ b/docs/docker-compose.yml @@ -0,0 +1,9 @@ +version: '3' +services: + composer: + container_name: m6w6/ext-ion-docs-composer + restart: "no" + volumes: + - ./:/app + build: . + user: "1000" diff --git a/docs/v0.0/index.html b/docs/v0.0/index.html index 1895bff..424b29e 100644 --- a/docs/v0.0/index.html +++ b/docs/v0.0/index.html @@ -45,6 +45,17 @@

PHP extension wrapping amzn/ion-c. See the Amazon ION specification.

+
+

Download the Stub file:

+ +
+ + + +
+ +
+ +
+ Edit +
+ + + +
+ +

Contributor Code of Conduct

+

As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating +documentation, submitting pull requests or patches, and other activities.

+

We are committed to making participation in this project a harassment-free +experience for everyone, regardless of level of experience, gender, gender +identity and expression, sexual orientation, disability, personal appearance, +body size, race, ethnicity, age, religion, or nationality.

+

Examples of unacceptable behavior by participants include:

+ +

Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct. By adopting this Code of Conduct, project +maintainers commit themselves to fairly and consistently applying these +principles to every aspect of managing this project. Project maintainers who do +not follow or enforce the Code of Conduct may be permanently removed from the +project team.

+

This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community.

+

Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by opening an issue or contacting one or more of the project maintainers.

+

This Code of Conduct is adapted from the +Contributor Covenant, version 1.2.0, +available at http://contributor-covenant.org/version/1/2/0/.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/: Security.html b/docs/v0.0/ion/: Security.html new file mode 100644 index 0000000..d34ab95 --- /dev/null +++ b/docs/v0.0/ion/: Security.html @@ -0,0 +1,135 @@ + + + + + + ★ Security - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

Security Policy

+

Supported Versions

+

This project is still in its early development stages, so please consider +any release not explicitly labeled as stable as experimental.

+ + + + + + + + + + + + + +
VersionSupported
0.x✓
+

Reporting a Vulnerability

+

If you find a security vulnerability, please refrain from creating a +public issue on Github, but rather contact me directly at mike@php.net +or another suitable private contact method.

+

Any past vulnerabilities should be found in release changelogs after they +have been fixed.

+

This is free and open source software provided under the the terms of +the 2-Clause-BSD-License, see the LICENSE file. +Thus, honor and goodwill is all being offered for reporting +-- or even fixing -- any vulnerability.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog.html b/docs/v0.0/ion/Catalog.html index 5135e9b..0514467 100644 --- a/docs/v0.0/ion/Catalog.html +++ b/docs/v0.0/ion/Catalog.html @@ -71,6 +71,10 @@ + +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Catalog/add.html b/docs/v0.0/ion/Catalog/add.html index 71434af..c521e50 100644 --- a/docs/v0.0/ion/Catalog/add.html +++ b/docs/v0.0/ion/Catalog/add.html @@ -73,10 +73,6 @@
  • ion\Symbol\Table $table
    The new table to add.
    • -

    Returns:

    - diff --git a/docs/v0.0/ion/Decimal.html b/docs/v0.0/ion/Decimal.html index 98b80fc..ff45343 100644 --- a/docs/v0.0/ion/Decimal.html +++ b/docs/v0.0/ion/Decimal.html @@ -96,6 +96,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Exception
    • diff --git a/docs/v0.0/ion/Exception.html b/docs/v0.0/ion/Exception.html index bf97b1a..c7a3685 100644 --- a/docs/v0.0/ion/Exception.html +++ b/docs/v0.0/ion/Exception.html @@ -43,6 +43,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/LOB.html b/docs/v0.0/ion/LOB.html index bc07f4b..cf489a2 100644 --- a/docs/v0.0/ion/LOB.html +++ b/docs/v0.0/ion/LOB.html @@ -52,6 +52,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Reader.html b/docs/v0.0/ion/Reader.html index 8dbe242..f7d037c 100644 --- a/docs/v0.0/ion/Reader.html +++ b/docs/v0.0/ion/Reader.html @@ -221,6 +221,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Serializer.html b/docs/v0.0/ion/Serializer.html index e22108c..7d0aa5d 100644 --- a/docs/v0.0/ion/Serializer.html +++ b/docs/v0.0/ion/Serializer.html @@ -57,6 +57,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Symbol.html b/docs/v0.0/ion/Symbol.html index 23dc761..18bfc3c 100644 --- a/docs/v0.0/ion/Symbol.html +++ b/docs/v0.0/ion/Symbol.html @@ -93,6 +93,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Timestamp.html b/docs/v0.0/ion/Timestamp.html index c8b4279..821eb02 100644 --- a/docs/v0.0/ion/Timestamp.html +++ b/docs/v0.0/ion/Timestamp.html @@ -62,6 +62,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Type.html b/docs/v0.0/ion/Type.html index 9351ae3..5867acf 100644 --- a/docs/v0.0/ion/Type.html +++ b/docs/v0.0/ion/Type.html @@ -43,6 +43,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Unserializer.html b/docs/v0.0/ion/Unserializer.html index 2154235..4e62282 100644 --- a/docs/v0.0/ion/Unserializer.html +++ b/docs/v0.0/ion/Unserializer.html @@ -57,6 +57,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/Writer.html b/docs/v0.0/ion/Writer.html index 148914a..20d882e 100644 --- a/docs/v0.0/ion/Writer.html +++ b/docs/v0.0/ion/Writer.html @@ -186,6 +186,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/serialize.html b/docs/v0.0/ion/serialize.html index 265ce7d..3f272eb 100644 --- a/docs/v0.0/ion/serialize.html +++ b/docs/v0.0/ion/serialize.html @@ -43,6 +43,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/docs/v0.0/ion/unserialize.html b/docs/v0.0/ion/unserialize.html index 83d3856..746ef29 100644 --- a/docs/v0.0/ion/unserialize.html +++ b/docs/v0.0/ion/unserialize.html @@ -43,6 +43,10 @@ +
  • ↲ ★ Contributing
    • + +
  • ↲ ★ Security
    • +
  • ↲ Catalog
  • ↲ Decimal
    • diff --git a/package.xml b/package.xml index ce04908..cdae013 100644 --- a/package.xml +++ b/package.xml @@ -40,6 +40,7 @@ https://awesomized.github.io/ext-ion/ + -- 2.30.2