Skip to content

Commit

Permalink
Merge branch 'main' into micheldiz/cherry-pick#209
Browse files Browse the repository at this point in the history
  • Loading branch information
rderbier committed Jul 26, 2024
2 parents 22b0df7 + 9353342 commit 74a11d4
Show file tree
Hide file tree
Showing 297 changed files with 8,034 additions and 3,178 deletions.
Binary file modified .DS_Store
Binary file not shown.
10 changes: 10 additions & 0 deletions .github/.vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
StylesPath = ./styles

MinAlertLevel = suggestion

Packages = write-good, Hugo

Vocab = Dgraph

[*.{md,txt}]
BasedOnStyles = Vale, write-good
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CODEOWNERS info: https://help.github.com/en/articles/about-code-owners
# Owners are automatically requested for review for PRs that changes code
# that they own.
* @rderbier @MichelDiz @damonfeldman @rarvikar @Rajakavitha1
* @dgraph-io/committers @rderbier
202 changes: 202 additions & 0 deletions .github/styles/Vocab/Dgraph/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
Dgraph
superflag
Dev
dev
Namespace
namespace
sharding
ACL
dgo
nquads
numgoroutines
goroutines
Goroutines
Mutex
mutex
Cluster
Diggy
upsert
Upsert
cond
uid
UID
txn
TXN
xid
lexing
subgraph
GraphQL
graphql
substring
fulltext
allofterms
anyofterms
orderasc
recurse
lt
le
ge
lt
gt
func
Ratel
alpha_grpc
Jepsen
RDF
listBackups

predicate
initial_release_date
genre_name
orderdesc
film_name
getJeunet
total_actors
totalActors
movie_total
perf_total
total_movies
num_actors
numFilms
character_name
someInfo
num_raters
avg_rating
num_rated
directorScore
grandTotal
director_id
last_name
has_for_child

performant
stderr
SDK
backtrace
Bleve
analyz
GraphDB
HTTP
gRPC
jq
JavaScript
transactionally
relref
Jaeger
zPages
hostname
Hostname
CLI
subcommand
Datadog
repo
Mobx
pprof
RDBMS
unencrypted

Zstandard
GB
JWT
JWK
Webapp
OAuth
Surveyo
surveyo
signup
SignUp
todo
Todo
signin
bool
API
nullable
geo
geojson
json
JSON
Grafana
Cloudwatch
uncheck
config
syscalls
tarball
unicode
Unicode
IP
codepoints
rebalance
rebalancing
unary
loopback
snake_case

Leia
Skywalker
Luke
Anakin
Darth
Vader
Luhrmann
Obi-Wan
Jolie
pitt
Pitt
jones
Jones
indiana
Indiana
francesc
spielberg
Spielberg
morgan
Morgan
Jeunet
Caro
steve
Taraji
Uber
Eifel
Github
GitHub
Golang
Gopher
Gophercon
Levenshtein
Minio
MinIO
systemd
gzipped
gzip
blogpost
jurassic
Jurassic
Farhan
Akhtar
Hashicorp

hy
eu
bg
zh
da
nl
en
fi
sv
ru
ro
ko
hu
hu
eg
ie

Baz
Tsui

aName
bName

addUser
elses
43 changes: 43 additions & 0 deletions .github/workflows/ci-spell-checking.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: ci-spell-checking

on:
push:
branches:
- main
pull_request:
types:
- opened
- reopened
- synchronize
- ready_for_review
branches:
- main

jobs:
lint:
runs-on: ubuntu-latest
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3
- name: Get changed files in the content folder
id: changed-files-specific
uses: tj-actions/changed-files@v41
with:
files: ./content/
- name: Install Vale
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: |
sudo apt-get update
sudo apt-get install curl
curl -Ls https://api.github.com/repos/errata-ai/vale/releases/latest \
| grep "browser_download_url.*vale_[0-9.]*_Linux_64-bit.tar.gz" \
| cut -d : -f 2,3 \
| tr -d \" \
| xargs curl -Ls \
| tar xz
sudo mv ./vale /usr/bin/vale
vale --config=./.github/.vale.ini sync
- name: Run Vale
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: vale --config=./.github/.vale.ini ${{ steps.changed-files-specific.outputs.all_changed_files }}
18 changes: 18 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'Close stale issues and PRs'
on:
schedule:
- cron: '30 1 * * *'

permissions:
issues: write
pull-requests: write

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
stale-issue-message: 'This issue has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.'
stale-pr-message: 'This PR has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.'
operations-per-run: 100
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.idea
.DS_Store
*.lock
static/images/.DS_Store
23 changes: 5 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,8 @@ Example, to reference a term, use a relref to the glossary :

We use [Hugo](https://gohugo.io/) for our documentation. You can use Hugo to locally stage doc updates before or after creating a PR.

1. Download and install the latest patch of hugo version v0.79.x from [here](https://github.com/gohugoio/hugo/releases/).
```bash
pushd ~/Downloads
VERSION=v0.79
TAG=$(curl -s https://api.github.com/repos/gohugoio/hugo/releases | jq '.[].tag_name' -r | grep $VERSION | head -1)
OS=$(uname -s)
if [[ ${OS,,} == "darwin" ]]; then
PKG=hugo_${TAG##v}_macOS-64bit.tar.gz
curl -sLO https://github.com/gohugoio/hugo/releases/download/${TAG}/${PKG}
tar xvzf $PKG hugo
sudo mv hugo /usr/local/bin/
else
PKG=hugo_${TAG##v}_Linux-64bit.deb
curl -sLO https://github.com/gohugoio/hugo/releases/download/${TAG}/${PKG}
sudo apt install $PKG
fi
popd
```
1. Download and install hugo version v0.91 from [here](https://github.com/gohugoio/hugo/releases/tag/v0.91.0).

2. Run the command below to get the theme.
```bash
pushd themes && git clone https://github.com/dgraph-io/hugo-docs && popd
Expand Down Expand Up @@ -118,3 +102,6 @@ Pass custom Go-GRPC example to the runnable by passing a `customExampleGoGRPC` t
```
**Note:** Runnable doesn't support passing a multiline string as an argument to a shortcode. Therefore, you have to create the whole custom example in a single line string by replacing newlines with `\n`.
## History
add Hypermode banner by updating the hugo-docs repository with topbat template.
3 changes: 2 additions & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = true
style = "vs"
style = "emacs"
tabWidth = 4
highlight_style = "solarized-dark"

[markup.tableOfContents]
endLevel = 4
Expand Down
Loading

0 comments on commit 74a11d4

Please sign in to comment.