Skip to content

Commit 39d8ac1

Browse files
author
Deploy from CI
committed
Deploy aa8c906 to gh-pages
0 parents  commit 39d8ac1

File tree

89 files changed

+18470
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+18470
-0
lines changed

‎.dockerignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
tests/
2+
**/.coverage
3+
*.md
4+
.github
5+
.gitignore
6+
Makefile
7+
.dockerignore
8+
Dockerfile
9+
pgosm-data/

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Something is not working as expected
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
10+
## What version of PgOSM Flex are you using?
11+
12+
<!-- What version number? Are you using Docker or on-server install? -->
13+
14+
## Docker image
15+
16+
<!-- If using Docker image, what tag or hash did you use? -->
17+
18+
## What operating system, osm2pgsql, and PostgreSQL/PostGIS versions are you using?
19+
20+
<!-- If not using Docker please elaborate on important versions -->
21+
22+
23+
## What did you do exactly?
24+
25+
<!-- Please provide the command(s) you used including all options etc. Include
26+
links to input files. -->
27+
28+
29+
## What did you expect to happen?
30+
31+
<!-- Describe in detail what you expected the above would do. -->
32+
33+
34+
## What did happen instead?
35+
36+
<!-- Please describe what happened and why you think this is wrong. Please include (or link to, if it is too verbose) the log output. -->
37+
38+
## What did you do to try analyzing the problem?
39+
40+
<!-- Describe what steps you already did to try analyzing the problem before
41+
reporting. -->

‎.github/PULL_REQUEST_TEMPLATE/pull_request.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Pull request
3+
about: Create a pull request to propose a change (bug fix, new feature, documentation, etc.) to PGOSM Flex.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Does this relate to an existing Issue?
11+
12+
<!-- Yes/No. Provide a link to the related issue if relevant. -->
13+
14+
## Describe the purpose of this change
15+
16+
<!-- Does this fix a bug? Does this add a new feature? Improving documentation? -->
17+
18+
19+
## Functional code?
20+
21+
<!-- Does the change as expected work? -->
22+
23+
<!-- Did you run `make` successfully? -->
24+
25+
## Additional Contributors
26+
27+
<!-- Are there additional contributors to this change beyond the code committer?
28+
If so, tag users and/or otherwise give credit where credit is due.
29+
-->
30+
31+

‎.github/workflows/deploy-book.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Based on https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions
2+
name: Deploy mdbook
3+
permissions:
4+
contents: write
5+
on:
6+
push:
7+
branches:
8+
- main
9+
10+
jobs:
11+
deploy:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
- name: Install Rust
18+
run: |
19+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
20+
echo "PATH=$HOME/.cargo/bin:$PATH" >> $GITHUB_ENV
21+
- name: Install mdbook
22+
run: |
23+
cargo install mdbook --version 0.4.32
24+
- name: Deploy GitHub Pages
25+
run: |
26+
# This assumes your book is in the root of your repository.
27+
# Just add a `cd` here if you need to change to another directory.
28+
cd docs
29+
mdbook build
30+
git worktree add gh-pages
31+
git config user.name "Deploy from CI"
32+
git config user.email ""
33+
cd gh-pages
34+
# Delete the ref to avoid keeping history.
35+
git update-ref -d refs/heads/gh-pages
36+
rm -rf *
37+
mv ../book/* .
38+
mv ../CNAME .
39+
git add .
40+
git commit -m "Deploy $GITHUB_SHA to gh-pages"
41+
git push --force --set-upstream origin gh-pages

‎.github/workflows/docker-build.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish PgOSM-Flex Docker image
2+
permissions:
3+
contents: read
4+
on:
5+
push:
6+
jobs:
7+
push_to_registry:
8+
name: Build and inspect PgOSM Flex image
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Check out the repo
12+
uses: actions/checkout@v2
13+
- name: Build image for local GH use
14+
id: docker_build_push
15+
uses: docker/build-push-action@v2
16+
with:
17+
context: .
18+
load: true
19+
push: false
20+
tags: rustprooflabs/pgosm-flex:ghdev
21+
- name: Inspect image
22+
run: |
23+
docker image inspect rustprooflabs/pgosm-flex:ghdev

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tests/tmp/*
2+
output/
3+
**/.coverage
4+
**/__pycache__
5+
pgosm-data/*
6+
docs/book/*
7+
.vscode/*

‎404.html‎

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="sidebar-visible no-js rust">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>Page not found - PgOSM Flex User Guide</title>
7+
<base href="/">
8+
9+
10+
<!-- Custom HTML head -->
11+
12+
<meta name="description" content="PgOSM Flex provides high quality OpenStreetMap datasets in PostGIS using the osm2pgsql Flex output">
13+
<meta name="viewport" content="width=device-width, initial-scale=1">
14+
<meta name="theme-color" content="#ffffff" />
15+
16+
<link rel="icon" href="favicon.svg">
17+
<link rel="shortcut icon" href="favicon.png">
18+
<link rel="stylesheet" href="css/variables.css">
19+
<link rel="stylesheet" href="css/general.css">
20+
<link rel="stylesheet" href="css/chrome.css">
21+
<link rel="stylesheet" href="css/print.css" media="print">
22+
23+
<!-- Fonts -->
24+
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
25+
<link rel="stylesheet" href="fonts/fonts.css">
26+
27+
<!-- Highlight.js Stylesheets -->
28+
<link rel="stylesheet" href="highlight.css">
29+
<link rel="stylesheet" href="tomorrow-night.css">
30+
<link rel="stylesheet" href="ayu-highlight.css">
31+
32+
<!-- Custom theme stylesheets -->
33+
34+
</head>
35+
<body>
36+
<div id="body-container">
37+
<!-- Provide site root to javascript -->
38+
<script>
39+
var path_to_root = "";
40+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "rust";
41+
</script>
42+
43+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
44+
<script>
45+
try {
46+
var theme = localStorage.getItem('mdbook-theme');
47+
var sidebar = localStorage.getItem('mdbook-sidebar');
48+
49+
if (theme.startsWith('"') && theme.endsWith('"')) {
50+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
51+
}
52+
53+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
54+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
55+
}
56+
} catch (e) { }
57+
</script>
58+
59+
<!-- Set the theme before any content is loaded, prevents flash -->
60+
<script>
61+
var theme;
62+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
63+
if (theme === null || theme === undefined) { theme = default_theme; }
64+
var html = document.querySelector('html');
65+
html.classList.remove('no-js')
66+
html.classList.remove('rust')
67+
html.classList.add(theme);
68+
html.classList.add('js');
69+
</script>
70+
71+
<!-- Hide / unhide sidebar before it is displayed -->
72+
<script>
73+
var html = document.querySelector('html');
74+
var sidebar = null;
75+
if (document.body.clientWidth >= 1080) {
76+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
77+
sidebar = sidebar || 'visible';
78+
} else {
79+
sidebar = 'hidden';
80+
}
81+
html.classList.remove('sidebar-visible');
82+
html.classList.add("sidebar-" + sidebar);
83+
</script>
84+
85+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
86+
<div class="sidebar-scrollbox">
87+
<ol class="chapter"><li class="chapter-item expanded affix "><a href="index.html">About PgOSM Flex</a></li><li class="chapter-item expanded affix "><a href="code-of-conduct.html">Code of Conduct</a></li><li class="chapter-item expanded affix "><a href="contributing.html">Contributing to PgOSM Flex</a></li><li class="chapter-item expanded affix "><li class="part-title">User Guide</li><li class="chapter-item expanded "><a href="quick-start.html"><strong aria-hidden="true">1.</strong> Quick Start</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="windows.html"><strong aria-hidden="true">1.1.</strong> Running on Windows</a></li></ol></li><li class="chapter-item expanded "><a href="customizations.html"><strong aria-hidden="true">2.</strong> Customize PgOSM Flex</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="common-customization.html"><strong aria-hidden="true">2.1.</strong> Common Customizations</a></li><li class="chapter-item expanded "><a href="layersets.html"><strong aria-hidden="true">2.2.</strong> Layersets</a></li><li class="chapter-item expanded "><a href="custom-indexes.html"><strong aria-hidden="true">2.3.</strong> Indexes</a></li><li class="chapter-item expanded "><a href="configure-postgres.html"><strong aria-hidden="true">2.4.</strong> Configure Postgres</a></li><li class="chapter-item expanded "><a href="data-files.html"><strong aria-hidden="true">2.5.</strong> Data Files</a></li></ol></li><li class="chapter-item expanded "><a href="query.html"><strong aria-hidden="true">3.</strong> Query examples</a></li><li class="chapter-item expanded "><a href="routing.html"><strong aria-hidden="true">4.</strong> Routing</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="routing-3.html"><strong aria-hidden="true">4.1.</strong> pgRouting 3</a></li><li class="chapter-item expanded "><a href="routing-4.html"><strong aria-hidden="true">4.2.</strong> pgRouting 4</a></li></ol></li><li class="chapter-item expanded "><a href="performance.html"><strong aria-hidden="true">5.</strong> Processing Time</a></li><li class="chapter-item expanded affix "><li class="part-title">Production Use</li><li class="chapter-item expanded "><a href="postgres-permissions.html"><strong aria-hidden="true">6.</strong> Postgres Permissions</a></li><li class="chapter-item expanded "><a href="postgres-external.html"><strong aria-hidden="true">7.</strong> Using External Postgres Connection</a></li><li class="chapter-item expanded "><a href="data-updates.html"><strong aria-hidden="true">8.</strong> Data updates</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="replication.html"><strong aria-hidden="true">8.1.</strong> Using Replication</a></li><li class="chapter-item expanded "><a href="relocate-data.html"><strong aria-hidden="true">8.2.</strong> Relocate Data</a></li><li class="chapter-item expanded "><a href="update-mode.html"><strong aria-hidden="true">8.3.</strong> Using Update Mode</a></li></ol></li><li class="chapter-item expanded "><a href="qgis-styles.html"><strong aria-hidden="true">9.</strong> QGIS Styles</a></li><li class="chapter-item expanded affix "><li class="part-title">Developers</li><li class="chapter-item expanded "><a href="force-load.html"><strong aria-hidden="true">10.</strong> Force Load</a></li><li class="chapter-item expanded "><a href="projects.html"><strong aria-hidden="true">11.</strong> Projects using PgOSM Flex</a></li><li class="chapter-item expanded "><a href="docker-build.html"><strong aria-hidden="true">12.</strong> Build and Push Docker Images</a></li><li class="chapter-item expanded "><a href="tests.html"><strong aria-hidden="true">13.</strong> Testing PgOSM Flex</a></li><li class="chapter-item expanded "><a href="qgis-styles-dev.html"><strong aria-hidden="true">14.</strong> Developing QGIS Styles</a></li><li class="chapter-item expanded "><a href="troubleshooting.html"><strong aria-hidden="true">15.</strong> Troubleshoot errors in osm2pgsql processing</a></li></ol>
88+
</div>
89+
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
90+
</nav>
91+
92+
<!-- Track and set sidebar scroll position -->
93+
<script>
94+
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
95+
sidebarScrollbox.addEventListener('click', function(e) {
96+
if (e.target.tagName === 'A') {
97+
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
98+
}
99+
}, { passive: true });
100+
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
101+
sessionStorage.removeItem('sidebar-scroll');
102+
if (sidebarScrollTop) {
103+
// preserve sidebar scroll position when navigating via links within sidebar
104+
sidebarScrollbox.scrollTop = sidebarScrollTop;
105+
} else {
106+
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
107+
var activeSection = document.querySelector('#sidebar .active');
108+
if (activeSection) {
109+
activeSection.scrollIntoView({ block: 'center' });
110+
}
111+
}
112+
</script>
113+
114+
<div id="page-wrapper" class="page-wrapper">
115+
116+
<div class="page">
117+
<div id="menu-bar-hover-placeholder"></div>
118+
<div id="menu-bar" class="menu-bar sticky">
119+
<div class="left-buttons">
120+
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
121+
<i class="fa fa-bars"></i>
122+
</button>
123+
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
124+
<i class="fa fa-paint-brush"></i>
125+
</button>
126+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
127+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
128+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
129+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
130+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
131+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
132+
</ul>
133+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
134+
<i class="fa fa-search"></i>
135+
</button>
136+
</div>
137+
138+
<h1 class="menu-title">PgOSM Flex User Guide</h1>
139+
140+
<div class="right-buttons">
141+
<a href="print.html" title="Print this book" aria-label="Print this book">
142+
<i id="print-button" class="fa fa-print"></i>
143+
</a>
144+
<a href="https://github.com/rustprooflabs/pgosm-flex" title="Git repository" aria-label="Git repository">
145+
<i id="git-repository-button" class="fa fa-github"></i>
146+
</a>
147+
148+
</div>
149+
</div>
150+
151+
<div id="search-wrapper" class="hidden">
152+
<form id="searchbar-outer" class="searchbar-outer">
153+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
154+
</form>
155+
<div id="searchresults-outer" class="searchresults-outer hidden">
156+
<div id="searchresults-header" class="searchresults-header"></div>
157+
<ul id="searchresults">
158+
</ul>
159+
</div>
160+
</div>
161+
162+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
163+
<script>
164+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
165+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
166+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
167+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
168+
});
169+
</script>
170+
171+
<div id="content" class="content">
172+
<main>
173+
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
174+
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
175+
176+
</main>
177+
178+
<nav class="nav-wrapper" aria-label="Page navigation">
179+
<!-- Mobile navigation buttons -->
180+
181+
182+
<div style="clear: both"></div>
183+
</nav>
184+
</div>
185+
</div>
186+
187+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
188+
189+
</nav>
190+
191+
</div>
192+
193+
194+
195+
196+
<script>
197+
window.playground_copyable = true;
198+
</script>
199+
200+
201+
<script src="elasticlunr.min.js"></script>
202+
<script src="mark.min.js"></script>
203+
<script src="searcher.js"></script>
204+
205+
<script src="clipboard.min.js"></script>
206+
<script src="highlight.js"></script>
207+
<script src="book.js"></script>
208+
209+
<!-- Custom JS scripts -->
210+
211+
212+
</div>
213+
</body>
214+
</html>

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pgosm-flex.com

‎FontAwesome/css/font-awesome.css‎

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎FontAwesome/fonts/FontAwesome.ttf‎

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)