Skip to content

Commit

Permalink
chore: update docs (#1009)
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveSkender authored Feb 26, 2023
1 parent 35317c5 commit ba28312
Show file tree
Hide file tree
Showing 32 changed files with 570 additions and 233 deletions.
19 changes: 14 additions & 5 deletions .github/workflows/a11y.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ on:
pull_request:
branches: [main]

env:
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
testing:
name: a11y
Expand All @@ -21,22 +24,28 @@ jobs:
uses: ruby/setup-ruby@v1
with:
working-directory: docs
ruby-version: 2.7.0
bundler-cache: true
ruby-version: 3.1.3
bundler-cache: false

- name: Install GEMs
working-directory: docs
env:
BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
run: |
pwd
BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle install
bundle install
- name: Build site
working-directory: docs
run: BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle exec jekyll build
env:
BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
run: bundle exec jekyll build

- name: Serve site
working-directory: docs
run: BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle exec jekyll serve --detach
env:
BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
run: bundle exec jekyll serve --detach

- name: Show environment
working-directory: docs
Expand Down
51 changes: 36 additions & 15 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ on:
pull_request:
branches: [main]

env:
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
testing:
name: URLs
Expand All @@ -12,37 +15,55 @@ jobs:
- name: Checkout source
uses: actions/checkout@v2

- name: Install Node
uses: actions/setup-node@v2
with:
node-version: '16'

- name: Install Ruby
uses: ruby/setup-ruby@v1
with:
working-directory: docs
ruby-version: 2.7.0
bundler-cache: true
ruby-version: 3.1.3
bundler-cache: false

- name: Install GEMs
working-directory: docs
env:
BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
run: |
pwd
BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle install
bundle install
- name: Install HTML Proofer
run: gem install html-proofer

- name: Replace "data-src"
uses: jacobtomlinson/gha-find-replace@v3
with:
find: "data-src"
replace: "src"
regex: false

- name: Replace "dotnet.stockindicators.dev"
uses: jacobtomlinson/gha-find-replace@v3
with:
find: "https://dotnet.stockindicators.dev"
replace: "http://127.0.0.1:4000"
regex: false

- name: Build site
working-directory: docs
run: BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle exec jekyll build
env:
BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
run: bundle exec jekyll build --trace

- name: Serve site
working-directory: docs
run: BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle exec jekyll serve --detach
env:
BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
run: bundle exec jekyll serve --detach

- name: Test for broken URLs
working-directory: docs
run: |
BUNDLE_GEMFILE="${{github.workspace}}/docs/GemFile" bundle exec htmlproofer _site \
--assume-extension \
--http-status-ignore "403,406,429,503,999" \
--url-swap "https\://dotnet.stockindicators.dev:http\://127.0.0.1:4000" \
--url-ignore "/fonts.gstatic.com/"
htmlproofer _site \
--no-enforce-https \
--ignore-status-codes "403,406,408,429,503,999" \
--swap-urls "https\://dotnet.stockindicators.dev:http\://127.0.0.1:4000" \
--ignore-urls "/fonts.gstatic.com/"
3 changes: 2 additions & 1 deletion .github/workflows/lock.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ jobs:
lock:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v3
- uses: dessant/lock-threads@v4
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
issue-inactive-days: "90"
pr-inactive-days: "30"
13 changes: 9 additions & 4 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,14 @@
"Mulloy",
"Munehisa",
"nobuild",
"NOKOGIRI",
"nupkg",
"Quong",
"Renko",
"Schaff",
"Seban",
"senkou",
"setx",
"Siepman",
"Skender",
"Smma",
Expand Down Expand Up @@ -162,19 +164,22 @@
"!vue"
],
"cSpell.ignoreWords": [
"GXEZ",
"LINQ",
"OHLC",
"OHLCV",
"adxr",
"autobuild",
"betatype",
"buildscript",
"autobuild",
"codeql",
"commandline",
"dessant",
"dwkk",
"endfor",
"endtype",
"gitversion",
"OHLC",
"OHLCV",
"LINQ",
"jacobtomlinson",
"livereload",
"lookback",
"noquotes",
Expand Down
3 changes: 1 addition & 2 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
KEEP THIS NOTICE OF ATTRIBUTION IN ALL DERIVED WORKS

Stock Indicators for .NET is an original open-source work
created by Dave Skender and many other community contributors.
created by Dave Skender and other community contributors.

Contributors:
https://github.com/DaveSkender/Stock.Indicators/contributors

Project site:
https://dotnet.stockindicators.dev
https://daveskender.github.io/Stock.Indicators

GitHub Repository:
https://github.com/DaveSkender/Stock.Indicators
Expand Down
5 changes: 2 additions & 3 deletions docs/GemFile
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ gem 'faraday-retry'
# local dev: bundle exec jekyll serve
group :jekyll_plugins do
gem 'github-pages'
gem "jekyll-github-metadata"
gem 'jemoji'
gem 'jekyll-remote-theme'
gem 'jekyll-sitemap'
gem 'jekyll-last-modified-at' # used in sitemap
gem 'jekyll-redirect-from'
end

# validate URLs with:
# bundle exec htmlproofer --http-status-ignore '999' _site;
gem "html-proofer", "~> 3.19.3"
gem "webrick" # needed for ruby > v3.0
73 changes: 33 additions & 40 deletions docs/GemFile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,20 @@ GIT
GEM
remote: https://rubygems.org/
specs:
activesupport (6.0.6)
activesupport (7.0.4.2)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
zeitwerk (~> 2.2, >= 2.2.2)
i18n (>= 1.6, < 2)
minitest (>= 5.1)
tzinfo (~> 2.0)
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.23.6)
concurrent-ruby (1.1.10)
commonmarker (0.23.8)
concurrent-ruby (1.2.2)
dnsruby (1.61.9)
simpleidn (~> 0.1)
em-websocket (0.5.3)
Expand All @@ -31,21 +30,22 @@ GEM
ethon (0.16.0)
ffi (>= 1.15.0)
execjs (2.8.1)
faraday (2.7.2)
faraday (2.7.4)
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
faraday-retry (2.0.0)
faraday (~> 2.0)
ffi (1.15.5-x64-mingw32)
ffi (1.15.5)
ffi (1.15.5-x64-mingw-ucrt)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (227)
github-pages (228)
github-pages-health-check (= 1.17.9)
jekyll (= 3.9.2)
jekyll (= 3.9.3)
jekyll-avatar (= 0.7.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.2.0)
jekyll-commonmark-ghpages (= 0.4.0)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.15.1)
jekyll-gist (= 1.5.0)
Expand Down Expand Up @@ -79,7 +79,7 @@ GEM
jemoji (= 0.12.0)
kramdown (= 2.3.2)
kramdown-parser-gfm (= 1.1.0)
liquid (= 4.0.3)
liquid (= 4.0.4)
mercenary (~> 0.3)
minima (= 2.5.1)
nokogiri (>= 1.13.6, < 2.0)
Expand All @@ -94,22 +94,14 @@ GEM
html-pipeline (2.14.3)
activesupport (>= 2)
nokogiri (>= 1.4)
html-proofer (3.19.4)
addressable (~> 2.3)
mercenary (~> 0.3)
nokogiri (~> 1.13)
parallel (~> 1.10)
rainbow (~> 3.0)
typhoeus (~> 1.3)
yell (~> 2.0)
http_parser.rb (0.8.0)
i18n (0.9.5)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
jekyll (3.9.2)
jekyll (3.9.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
i18n (>= 0.7, < 2)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (>= 1.17, < 3)
Expand All @@ -125,11 +117,11 @@ GEM
coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.4.0)
commonmarker (~> 0.22)
jekyll-commonmark-ghpages (0.2.0)
commonmarker (~> 0.23.4)
jekyll-commonmark-ghpages (0.4.0)
commonmarker (~> 0.23.7)
jekyll (~> 3.9.0)
jekyll-commonmark (~> 1.4.0)
rouge (>= 2.0, < 4.0)
rouge (>= 2.0, < 5.0)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.15.1)
Expand Down Expand Up @@ -220,7 +212,7 @@ GEM
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
Expand All @@ -230,18 +222,18 @@ GEM
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.17.0)
nokogiri (1.14.0-x64-mingw32)
nokogiri (1.14.2-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.14.2-x86_64-linux)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
parallel (1.22.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
posix-spawn (0.3.15)
public_suffix (4.0.7)
racc (1.6.2)
rainbow (3.1.1)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
Expand All @@ -262,33 +254,34 @@ GEM
unf (~> 0.1.4)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (1.4.0)
ethon (>= 0.9.0)
tzinfo (1.2.10)
thread_safe (~> 0.1)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2-x64-mingw32)
unf_ext (0.0.8.2)
unf_ext (0.0.8.2-x64-mingw-ucrt)
unicode-display_width (1.8.0)
wdm (0.1.1)
yell (2.2.2)
zeitwerk (2.6.6)
webrick (1.8.1)

PLATFORMS
x64-mingw32
x64-mingw-ucrt
x86_64-linux

DEPENDENCIES
eventmachine (= 1.2.7)!
faraday-retry
github-pages
html-proofer (~> 3.19.3)
jekyll-github-metadata
jekyll-last-modified-at
jekyll-redirect-from
jekyll-remote-theme
jekyll-sitemap
jemoji
wdm (>= 0.1.1)
webrick

BUNDLED WITH
2.2.31
2.4.7
Loading

0 comments on commit ba28312

Please sign in to comment.