Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove legacy site code #3030

Merged
merged 2 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/githubpages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:

- name: Dokka
id: Dokka
run: ./gradlew -Pversion=${{ github.event.release.tag_name }} cleanDocs dokkaHtmlMultiModule -Pgithubpages=true
run: ./gradlew -Pversion=${{ github.event.release.tag_name }} dokkaHtmlMultiModule -Pgithubpages=true

- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v3
Expand Down
29 changes: 0 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,33 +139,6 @@ public sealed class Option<out A> {

If your snippet is showing examples on how to use the public APIs in a broader scenario (like describing FP patterns or similar), then you'll add those snippets to the described docs Markdown file.

## How to run the website in your local workspace

```sh
./gradlew :arrow-site:buildSite
```

That Gradle task is equivalent to run Dokka and Jekyll build:

```bash
./gradlew dokkaGfm
cd arrow-site
bundle install --gemfile Gemfile --path vendor/bundle
bundle exec jekyll serve -s build/site
```

This will install any needed dependencies locally, and will use it to launch the complete website in [127.0.0.1:4000](http://127.0.0.1:4000) so you can open it with a standard browser.

If you get an error while installing the Ruby gem _http_parser_, check if the path to your Arrow directory contains spaces. According to this [issue](https://github.com/tmm1/http_parser.rb/issues/47), the installation with spaces in the path is currently not working.

### How to test links

Test for broken links in documentation using

```sh
wget --spider -r -nd -nv -l 5 http://127.0.0.1:4000
```

## How to propose an improvement

If it's the first time you contribute with a GitHub repository, take a look at [Collaborating with issues and pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
Expand Down Expand Up @@ -295,8 +268,6 @@ This short guideline provides all the things to keep in mind when adding a new m
- Add `<module>/gradle.properties`
- Add `<module>/build.gradle.kts`
- Update `settings.gradle.kts`
- Website:
- Update [sidebar files](arrow-site/docs/_data)
- Utilities:
- Update BOM file: [build.gradle](arrow-stack/build.gradle)

Expand Down
5 changes: 0 additions & 5 deletions arrow-site/Gemfile

This file was deleted.

34 changes: 0 additions & 34 deletions arrow-site/build.gradle.kts

This file was deleted.

20 changes: 0 additions & 20 deletions arrow-site/docs/_code/analysis-home-code.md

This file was deleted.

38 changes: 0 additions & 38 deletions arrow-site/docs/_code/core-home-code.md

This file was deleted.

39 changes: 0 additions & 39 deletions arrow-site/docs/_code/fx-home-code.md

This file was deleted.

25 changes: 0 additions & 25 deletions arrow-site/docs/_code/meta-home-code.md

This file was deleted.

53 changes: 0 additions & 53 deletions arrow-site/docs/_code/optics-home-code.md

This file was deleted.

51 changes: 0 additions & 51 deletions arrow-site/docs/_config.yml

This file was deleted.

36 changes: 0 additions & 36 deletions arrow-site/docs/_config_for_landing_page.yml

This file was deleted.

8 changes: 0 additions & 8 deletions arrow-site/docs/_data/commons.yml

This file was deleted.

20 changes: 0 additions & 20 deletions arrow-site/docs/_data/doc-versions.yml

This file was deleted.

Loading