Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

Commit

Permalink
feat: update organization
Browse files Browse the repository at this point in the history
  • Loading branch information
geerteltink committed Nov 8, 2019
1 parent 688d327 commit 1ab0636
Show file tree
Hide file tree
Showing 17 changed files with 27 additions and 77 deletions.
23 changes: 0 additions & 23 deletions .github/workflows/docker-image.yml

This file was deleted.

24 changes: 0 additions & 24 deletions .github/workflows/github-pages.yml

This file was deleted.

9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# docs-sdk

[![github-pages](https://github.com/iswai/docs-sdk/workflows/github-pages/badge.svg)](https://github.com/iswai/docs-sdk/actions)
[![docker-image](https://github.com/iswai/docs-sdk/workflows/docker-image/badge.svg)](https://github.com/iswai/docs-sdk/actions)

This project consists of a collection of tools to generate the documentation for the ISWAI
This project consists of a collection of tools to generate the documentation for the XTREAMWAYZ
organization. It's very opinionated and contains hugo templates and css files as we like them.

## Documentation
Expand All @@ -14,10 +11,10 @@ to the documentation, please submit a pull request.
## Contributing

***BEFORE you start work on a feature or fix***, please read & follow the
[contributing guidelines](https://github.com/iswai/.github/blob/master/CONTRIBUTING.md#contributing)
[contributing guidelines](https://github.com/xtreamwayz/.github/blob/master/CONTRIBUTING.md#contributing)
to help avoid any wasted or duplicate effort.

## Copyright and license

Code released under the [MIT License](https://github.com/iswai/.github/blob/master/LICENSE.md).
Code released under the [MIT License](https://github.com/xtreamwayz/.github/blob/master/LICENSE.md).
Documentation distributed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'iswai docs sdk'
name: 'xtreamwayz docs sdk'
description: 'Generate project docs'
inputs:
command:
Expand Down
6 changes: 3 additions & 3 deletions actions/gh-pages-deploy
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# PUBLISH_REPOSITORY: github_organization/project_name * optional
# PUBLISH_BRANCH: gh-pages * optional
# PUBLISH_DIR: ./build * optional
# run: wget -O - https://raw.githubusercontent.com/iswai/docs-sdk/master/actions/gh-pages-deploy | bash
# run: wget -O - https://raw.githubusercontent.com/xtreamwayz/docs-sdk/master/actions/gh-pages-deploy | bash
#
set -e

Expand Down Expand Up @@ -42,8 +42,8 @@ rm -rf /tmp/deploy
print_info "Checking out ${PUBLISH_BRANCH}"
git clone "${REMOTE_REPO}" /tmp/deploy
cd /tmp/deploy
git config user.name "iswai-bot"
git config user.email "57135024+iswai[email protected]"
git config user.name "xtreamwayz-bot"
git config user.email "57135024+xtreamwayz[email protected]"
git checkout "${PUBLISH_BRANCH}"

print_info "Removing old files"
Expand Down
2 changes: 1 addition & 1 deletion actions/gh-pages-prepare
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# env:
# PUBLISH_BRANCH: gh-pages * optional
# PUBLISH_DIR: ./build * optional
# run: wget -O - https://raw.githubusercontent.com/iswai/docs-sdk/master/actions/gh-pages-prepare | bash
# run: wget -O - https://raw.githubusercontent.com/xtreamwayz/docs-sdk/master/actions/gh-pages-prepare | bash
#
set -e

Expand Down
2 changes: 1 addition & 1 deletion config/_default/config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
baseURL: http://localhost:1313/
title: iswai
title: xtreamwayz

defaultContentLanguage: en
languageCode: en-us
Expand Down
2 changes: 1 addition & 1 deletion config/_default/params.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
organization: iswai
organization: xtreamwayz
projects:
- devops
- docs-sdk
2 changes: 1 addition & 1 deletion docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: Description.
---

This project consists of a collection of tools to generate the documentation
for the ISWAI organization. It's very opinionated and contains hugo templates
for the XTREAMWAYZ organization. It's very opinionated and contains hugo templates
and css files as we like them. You can't really use it for something else
unless you modify it and adjust to your needs.
2 changes: 1 addition & 1 deletion docs/config.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
baseURL: https://iswai.github.io/docs-sdk/
baseURL: https://xtreamwayz.github.io/docs-sdk/
title: docs-sdk
8 changes: 4 additions & 4 deletions docs/current/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ version: "1.0"
---

This project consists of a collection of tools to generate the documentation
for the ISWAI organization. It's very opinionated and contains hugo templates
for the XTREAMWAYZ organization. It's very opinionated and contains hugo templates
and css files as we like them.

## Preview documentation

```bash
# Build documentation into ./build
docker run --rm -it -v ${PWD}:/src iswai/docs build
docker run --rm -it -v ${PWD}:/src xtreamwayz/docs build

# Preview documentation at http:/localhost:1313/
docker run --rm -it -p 1313:1313 -v ${PWD}:/src iswai/docs server
docker run --rm -it -p 1313:1313 -v ${PWD}:/src xtreamwayz/docs server

# Preview documentation at http:/localhost:1313/ (including draft and future content)
docker run --rm -it -p 1313:1313 -v ${PWD}:/src iswai/docs preview
docker run --rm -it -p 1313:1313 -v ${PWD}:/src xtreamwayz/docs preview
```

## Build container locally
Expand Down
2 changes: 1 addition & 1 deletion docs/params.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
organization: iswai
organization: xtreamwayz
project: docs-sdk
current: "1.0"
develop:
Expand Down
2 changes: 1 addition & 1 deletion layouts/landingpage/site.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <h2>Projects</h2>
<a class="card border-primary" style="width: 18rem;" href="{{ ( printf "/%s/" $project ) | absURL }}">
<div class="card-body text-center">
<h3 class="card-title">{{ $project }}</h3>
<h4 class="card-subtitle mb-2 text-muted">iswai/{{ $project }}</h6>
<h4 class="card-subtitle mb-2 text-muted">xtreamwayz/{{ $project }}</h6>
</div>
</a>
{{ end }}
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="container">
<p class="text-center">
&copy; 2019 <a href="https://www.elt.ink/"> Geert Eltink</a> |
Code released under <a href="https://github.com/iswai/.github/blob/master/LICENSE.md">MIT License</a>. |
Code released under <a href="https://github.com/xtreamwayz/.github/blob/master/LICENSE.md">MIT License</a>. |
Documentation distributed under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/header.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<header class="app-header navbar navbar-expand navbar-dark bg-primary text-white">
<nav class="nav-container container">
<a class="navbar-brand" href="{{ "/" | absURL }}" aria-label="It starts with an idea">
&#x1f914; ISWAI
&#x1f914; XTREAMWAYZ
</a>
<ul class="navbar-nav">
<li class="nav-item dropdown">
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "docs-sdk",
"version": "1.0.0",
"description": "A development kit for generating docs for the ISWAI organization",
"description": "A development kit for generating docs for the XTREAMWAYZ organization",
"repository": {
"type": "git",
"url": "git+https://github.com/iswai/docs-sdk.git"
"url": "git+https://github.com/xtreamwayz/docs-sdk.git"
},
"author": "Geert Eltink (https://www.elt.ink/)",
"license": "MIT",
"bugs": {
"url": "https://github.com/iswai/docs-sdk/issues"
"url": "https://github.com/xtreamwayz/docs-sdk/issues"
},
"homepage": "https://github.com/iswai/docs-sdk#readme",
"homepage": "https://github.com/xtreamwayz/docs-sdk#readme",
"dependencies": {
"@fortawesome/fontawesome-free": "^5.11.2",
"@fullhuman/postcss-purgecss": "^1.3.0",
Expand Down
6 changes: 3 additions & 3 deletions static/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Placeholder branch for documentation

This documentation is automatically generated with [iswai/docs-sdk](https://iswai.github.io/docs-sdk/)
and publicly hosted on GitHub Pages at <https://iswai.github.io/>.
This documentation is automatically generated with [xtreamwayz/docs-sdk](https://xtreamwayz.github.io/docs-sdk/)
and publicly hosted on GitHub Pages at <https://xtreamwayz.github.io/>.

## Copyright and license

© 2019 [Geert Eltink](https://www.elt.ink/) |
Code released under [MIT License](https://github.com/iswai/.github/blob/master/LICENSE.md). |
Code released under [MIT License](https://github.com/xtreamwayz/.github/blob/master/LICENSE.md). |
Documentation distributed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).

0 comments on commit 1ab0636

Please sign in to comment.