Skip to content
This repository has been archived by the owner on Jul 24, 2021. It is now read-only.

Commit

Permalink
Merge pull request #788 from joyent/ether/public-docs
Browse files Browse the repository at this point in the history
remove remnants of old /public/doc/ documentation
  • Loading branch information
karenetheridge authored May 21, 2019
2 parents d05f2a5 + e98c5f0 commit 7b1234b
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 27 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ CHANGELOG.md
# Conch
conch.conf
report
public/doc
docs/conch-api/index.html
log
bin/hypnotoad.pid
nytprof
Expand Down
11 changes: 1 addition & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ morbo: ## Run under morbo, listening on :5001
build: local ## Install deps (TODO: and build docs)

clean:
\rm -rf local log public/doc
\rm -rf local log

local: cpanfile.snapshot ## Install perl dependencies
# '--deployment' installs the same dep versions that are in the lockfile
Expand All @@ -25,21 +25,12 @@ test: local ## Run tests
test_loud: local ## Run tests but tell the Mojo harness to log verbosely to log/
MOJO_LOG_LEVEL=debug carton exec prove -lpr t/

doc: public/doc/index.html ## Build docs

.PHONY: ghdocs
ghdocs: build
@rm -rf docs/modules
@mkdir -p docs/modules
@carton exec misc/pod2githubpages $$(find lib -type f -iname \*.pm)

public/doc/index.html: \
docs/conch-api/openapi-spec.yaml \
docs/conch-api/yarn.lock docs/conch-api/index.js
@cd docs/conch-api && yarn install && yarn run render
@mkdir -p public/doc
@cp docs/conch-api/index.html public/doc/index.html

watch-test:
@find lib t | entr -r -c make test

Expand Down
4 changes: 0 additions & 4 deletions docs/modules/Conch::Route.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ Set up the full route structure

Unless otherwise specified all routes require authentication.

### `/doc`

- Does not require authentication.

### `GET /ping`

- Does not require authentication.
Expand Down
11 changes: 0 additions & 11 deletions lib/Conch/Route.pm
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,6 @@ sub all_routes (
$root->add_type(uuid => Conch::UUID::UUID_FORMAT);


# GET /doc
$root->get('/doc', sub ($c) { $c->reply->static('public/doc/index.html') });

# GET /ping
$root->get('/ping', sub ($c) { $c->status(200, { status => 'ok' }) });

Expand Down Expand Up @@ -108,14 +105,6 @@ __END__
Unless otherwise specified all routes require authentication.
=head3 C</doc>
=over 4
=item * Does not require authentication.
=back
=head3 C<GET /ping>
=over 4
Expand Down

0 comments on commit 7b1234b

Please sign in to comment.