Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
9bfc2ef
Add a blank hugo theme
samredai Jun 7, 2022
6893996
Move landing-page theme to iceberg-theme directory and symlink to bot…
samredai Jun 8, 2022
e677bfb
Extend iceberg-theme to handle docs site layout
samredai Jun 9, 2022
12e63cd
Style sidebar and allow disableSidebar front-matter setting
samredai Jun 10, 2022
59e8a31
Add introduction to navbar and chevrons
samredai Jun 11, 2022
e89b845
Chevron movement
samredai Jun 11, 2022
a864913
Remove transition.js, no longer needed
samredai Jun 11, 2022
c914ae3
Add _index.md
samredai Jun 11, 2022
4c4760f
Fix chevron position on page load
samredai Jun 12, 2022
562378b
Add gitignore to ignore sub-directories in docs/content
samredai Jun 13, 2022
eddb862
Adding index file for introduction page
samredai Jun 13, 2022
dc6a20f
Remove leftnav icons, convert topnav to a hugo controlled menu
samredai Jun 13, 2022
8e572dd
Change font-weight to be consistent for topnav
samredai Jun 13, 2022
59ee5eb
Move GitHub and Slack logo images to custom theme
samredai Jun 15, 2022
fa4d65d
Add json file template for Hugo to generate json search index
samredai Jun 15, 2022
390a731
Add searchbar, github icon, and slack icon to topnav, plus search scr…
samredai Jun 15, 2022
2d8b4ee
iceberg-theme.css and iceberg-theme.js, also changed media query for …
samredai Jun 15, 2022
88c8a0f
Style searchbar and search results box
samredai Jun 16, 2022
1e78bdc
Add any directory named public to gitignore
samredai Jun 16, 2022
a695168
Overlay search results, clear search results on search input clear
samredai Jun 16, 2022
f5af4d9
Remove flexsearch and hugo-book completely
samredai Jun 17, 2022
c668f7c
Add ASF License headers and remove unused files
samredai Jun 17, 2022
2e8646d
Comments
samredai Jun 17, 2022
c65ee03
Fix symlinks to be relative
samredai Jun 22, 2022
23169c6
Include external icons for external-links in left nav
samredai Jun 22, 2022
8369ca8
Version dropdown selector and removed more files no longer needed
samredai Jun 22, 2022
d2de7d3
Add Javadoc to leftnav and remove newline headers
samredai Jun 22, 2022
afa6498
Expand relevant section in left nav, limit search box to 65% height
samredai Jun 23, 2022
90d6083
Changing links in docs site to landing-page to be relative
samredai Jun 23, 2022
6c1005a
Changing search-results max-height to a specific value
samredai Jun 23, 2022
1746592
Remove BookSection site param, no longer used
samredai Jun 23, 2022
e175233
Remove leading slash for relative urls
samredai Jun 23, 2022
69534e3
Enable urls relative to baseurl
samredai Jun 23, 2022
c81d884
Set sidebar and TOC as overlays instead of grid columns
samredai Jun 24, 2022
860640f
Remove min-width and fix leftnav collapse on smaller screens
samredai Jun 24, 2022
e993832
Rearrange for diff conflict
samredai Jun 24, 2022
f2dae10
Add missing title's in front-matter, missing titles make search resul…
samredai Jun 24, 2022
7c6e7f1
Center top navbar content
samredai Jun 24, 2022
c6cd2fa
Revert to grid layout, add centered <section> with left and right mar…
samredai Jun 25, 2022
921fb10
Set overflow scroll to auto and remove left margins
samredai Jun 25, 2022
588aa4f
Wrapping search-results-container in <section> for proper margins
samredai Jun 25, 2022
f360b75
Use inline tables for docs site menu configuration (194 lines to 45 l…
samredai Jun 26, 2022
2b36061
Use inline tables for docs site menu configuration (118 lines to 31 l…
samredai Jun 26, 2022
5f6d79f
Remove spec.md and view-spec.md (sourced in iceberg repo)
samredai Jun 26, 2022
d4c245a
Add StarRocks to docs menu
samredai Jun 26, 2022
e11e383
Process pre=relative tag for version drop-down
samredai Jun 26, 2022
dc4a82d
Add excludeFromSearch front-matter parameter to exclude pages from se…
samredai Jun 27, 2022
97c43d4
Filter pages before checking for excludeFromSearch
samredai Jun 27, 2022
b4969ae
Remove google analytics hook, only load termynal.js if needed
samredai Jun 27, 2022
01dd1df
Move Community link to Join in dropdown
samredai Jun 27, 2022
98785a3
Load termynal for landing-page, set z-index for dropdowns
samredai Jun 27, 2022
9870f28
Set parent menu for Join
samredai Jun 27, 2022
17037c4
Fix TOC in content margin area
samredai Jun 28, 2022
e84355d
Setting single grid column for TOC only pages
samredai Jun 28, 2022
b3fcdda
Rearrange topnav menu
samredai Jun 28, 2022
523d1d8
Absolute center top navbar
samredai Jun 28, 2022
01b1cf4
Fix indentation on TOC
samredai Jun 28, 2022
2ea3a06
Add in specs and rename Join to Community
samredai Jun 28, 2022
a88b860
Add in missing comma
samredai Jun 28, 2022
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 .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Hugo generated directories
/public
public
resources
!javadoc/resources

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ cd iceberg-docs

To start the landing page site locally, run:
```shell
cd landing-page && hugo serve
(cd landing-page && hugo serve)
```

To start the documentation site locally, run:
```shell
cd docs && hugo serve
(cd docs && hugo serve)
```

If you would like to see how the latest website looks based on the documentation in the Iceberg repository, you can copy docs to this repository by:
Expand Down Expand Up @@ -159,4 +159,4 @@ Redirects within one of the two sites can easily be done using the `aliases` key
You can read more about this Hugo URL Management feature [here](https://gohugo.io/content-management/urls/#yaml-front-matter).

For root level redirects that are outside of both sites, the `./redirects` directory contains pages with redirect `meta` tags.
These are all deployed at the root level of the `asf-site` branch by the `Deploy redirects` step in the [deployment workflow](./.github/workflows/deploy.yml).
These are all deployed at the root level of the `asf-site` branch by the `Deploy redirects` step in the [deployment workflow](./.github/workflows/deploy.yml).
Empty file removed docs/_default2/list.html
Empty file.
Empty file removed docs/_default2/single.html
Empty file.
108 changes: 0 additions & 108 deletions docs/assets/_custom.scss

This file was deleted.

64 changes: 61 additions & 3 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,70 @@
baseURL = "" # This is populated by the github deploy workflow and is equal to "<domainName>/docs/<version|latest>"
canonifyURLs = "true"
relativeURLs = "true"
languageCode = "en-us"
title = "Apache Iceberg"
theme= "hugo-book"
theme= "iceberg-theme"

[params]
BookTheme = 'auto'
BookLogo = "img/iceberg-logo-icon.png"
siteType = "docs"
search = true
versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
versions.nessie = "0.18.0"
latestVersions.iceberg = "0.13.2" # This is used for the version badge on the "latest" site version
BookSection='docs' # This determines which directory will inform the left navigation menu
disableHome=true

[outputFormats.SearchIndex]
baseName = "search"
mediaType = "application/json"

[outputs]
home = [ "HTML", "RSS", "SearchIndex" ]

[menu]
versions = [
{ name = "latest", pre = "relative", url = "../latest", weight = 1 },
{ name = "0.13.2", pre = "relative", url = "../0.13.2", weight = 997 },
{ name = "0.13.1", pre = "relative", url = "../0.13.1", weight = 998 },
{ name = "0.13.0", pre = "relative", url = "../0.13.0", weight = 999 },
{ name = "0.12.1", pre = "relative", url = "../0.12.1", weight = 1000 }
]
topnav = [
{ name = "Docs", url = "/docs/latest", weight = 100 },
{ name = "Releases", pre = "relative", url = "../../releases", weight = 600 },
{ name = "Spark", url = "/docs/latest/getting-started", weight = 200 },
{ name = "Flink", url = "/docs/latest/flink", weight = 300 },
{ name = "Trino", url = "https://trino.io/docs/current/connector/iceberg.html", weight = 400 },
{ name = "Presto", url = "../../how-to-release" , weight = 500 },
{ name = "Blogs", pre = "relative", url = "../../blogs", weight = 998 },
{ name = "Talks", pre = "relative", url = "../../talks", weight = 999 },
{ name = "Roadmap", pre = "relative", url = "../../roadmap", weight = 997 },
{ name = "Project", weight = 1100 },
{ name = "Community", parent = "Project", pre = "relative", url = "../../community", weight = 100 },
{ name = "Spec", parent = "Project", pre = "relative", url = "../../spec", weight = 200 },
{ name = "View Spec", parent = "Project", pre = "relative", url = "../../view-spec", weight = 300 },
{ name = "Puffin Spec", parent = "Project", pre = "relative", url = "../../puffin-spec", weight = 400 },
{ name = "How To Release", parent = "Project", pre = "relative", url = "../../how-to-release", weight = 500 },
{ name = "Terms", parent = "Project", pre = "relative", url = "../../terms", weight = 600 },
{ name = "ASF", weight = 1200 },
{ name = "License", identifier = "_license", parent = "ASF", url = "https://www.apache.org/licenses/" },
{ name = "Security", identifier = "_security", parent = "ASF", url = "https://www.apache.org/security/" },
{ name = "Sponsors", identifier = "_sponsors", parent = "ASF", url = "https://www.apache.org/foundation/thanks.html" },
{ name = "Donate", identifier = "_donate", parent = "ASF", url = "https://www.apache.org/foundation/sponsorship.html" },
{ name = "Events", identifier = "_events", parent = "ASF", url = "https://www.apache.org/events/current-event.html" },
]
main = [ # Main menu, docs site left nav
{ name = "Introduction", url = "/", weight = 1},
{ name = "Tables", weight = 100 },
{ name = "Spark", weight = 200},
{ name = "Flink", weight = 300},
{ name = "Trino", identifier = "_trino", weight = 500, url = "https://trino.io/docs/current/connector/iceberg.html" },
{ name = "Presto", identifier = "_presto", weight = 600, url = "https://prestodb.io/docs/current/connector/iceberg.html" },
{ name = "Dremio", identifier = "_dremio", weight = 700, url = "https://docs.dremio.com/data-formats/apache-iceberg/" },
{ name = "StarRocks", identifier = "_starrocks", weight = 701, url = "https://docs.starrocks.com/en-us/main/using_starrocks/External_table#apache-iceberg-external-table" },
{ name = "Amazon Athena", identifier = "_athena", weight = 800, url = "https://docs.aws.amazon.com/athena/latest/ug/querying-iceberg.html" },
{ name = "Amazon EMR", identifier = "_emr", weight = 900, url = "https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-iceberg-create-cluster.html" },
{ name = "Integrations", weight = 1000 },
{ name = "API", weight = 1100},
{ name = "Javadoc", pre = "relative", url = "../../javadoc/latest", weight = 1200} # `url` is populated by the github deploy workflow and is equal to "../../javadoc/<branch name>"
]
1 change: 1 addition & 0 deletions docs/content/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.md
54 changes: 0 additions & 54 deletions docs/content/_index.md

This file was deleted.

93 changes: 0 additions & 93 deletions docs/layouts/_default/baseof.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/layouts/partials/docs/brand.html

This file was deleted.

14 changes: 0 additions & 14 deletions docs/layouts/partials/docs/header.html

This file was deleted.

Loading