Skip to content

Commit 36c00ce

Browse files
author
Deploy from CI
committed
Deploy ede13a4 to gh-pages
0 parents  commit 36c00ce

File tree

87 files changed

+17764
-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.

87 files changed

+17764
-0
lines changed

‎.dockerignore

+9
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

+41
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

+31
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

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

‎.github/workflows/docker-build.yml

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

‎.gitignore

+7
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

+221
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="rust" dir="ltr">
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 class="sidebar-visible no-js">
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('rust')
66+
html.classList.add(theme);
67+
var body = document.querySelector('body');
68+
body.classList.remove('no-js')
69+
body.classList.add('js');
70+
</script>
71+
72+
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
73+
74+
<!-- Hide / unhide sidebar before it is displayed -->
75+
<script>
76+
var body = document.querySelector('body');
77+
var sidebar = null;
78+
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
79+
if (document.body.clientWidth >= 1080) {
80+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
81+
sidebar = sidebar || 'visible';
82+
} else {
83+
sidebar = 'hidden';
84+
}
85+
sidebar_toggle.checked = sidebar === 'visible';
86+
body.classList.remove('sidebar-visible');
87+
body.classList.add("sidebar-" + sidebar);
88+
</script>
89+
90+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
91+
<div class="sidebar-scrollbox">
92+
<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 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 usages</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>
93+
</div>
94+
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
95+
<div class="sidebar-resize-indicator"></div>
96+
</div>
97+
</nav>
98+
99+
<!-- Track and set sidebar scroll position -->
100+
<script>
101+
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
102+
sidebarScrollbox.addEventListener('click', function(e) {
103+
if (e.target.tagName === 'A') {
104+
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
105+
}
106+
}, { passive: true });
107+
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
108+
sessionStorage.removeItem('sidebar-scroll');
109+
if (sidebarScrollTop) {
110+
// preserve sidebar scroll position when navigating via links within sidebar
111+
sidebarScrollbox.scrollTop = sidebarScrollTop;
112+
} else {
113+
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
114+
var activeSection = document.querySelector('#sidebar .active');
115+
if (activeSection) {
116+
activeSection.scrollIntoView({ block: 'center' });
117+
}
118+
}
119+
</script>
120+
121+
<div id="page-wrapper" class="page-wrapper">
122+
123+
<div class="page">
124+
<div id="menu-bar-hover-placeholder"></div>
125+
<div id="menu-bar" class="menu-bar sticky">
126+
<div class="left-buttons">
127+
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
128+
<i class="fa fa-bars"></i>
129+
</label>
130+
<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">
131+
<i class="fa fa-paint-brush"></i>
132+
</button>
133+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
134+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
135+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
136+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
137+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
138+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
139+
</ul>
140+
<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">
141+
<i class="fa fa-search"></i>
142+
</button>
143+
</div>
144+
145+
<h1 class="menu-title">PgOSM Flex User Guide</h1>
146+
147+
<div class="right-buttons">
148+
<a href="print.html" title="Print this book" aria-label="Print this book">
149+
<i id="print-button" class="fa fa-print"></i>
150+
</a>
151+
<a href="https://github.com/rustprooflabs/pgosm-flex" title="Git repository" aria-label="Git repository">
152+
<i id="git-repository-button" class="fa fa-github"></i>
153+
</a>
154+
155+
</div>
156+
</div>
157+
158+
<div id="search-wrapper" class="hidden">
159+
<form id="searchbar-outer" class="searchbar-outer">
160+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
161+
</form>
162+
<div id="searchresults-outer" class="searchresults-outer hidden">
163+
<div id="searchresults-header" class="searchresults-header"></div>
164+
<ul id="searchresults">
165+
</ul>
166+
</div>
167+
</div>
168+
169+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
170+
<script>
171+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
172+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
173+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
174+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
175+
});
176+
</script>
177+
178+
<div id="content" class="content">
179+
<main>
180+
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
181+
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
182+
183+
</main>
184+
185+
<nav class="nav-wrapper" aria-label="Page navigation">
186+
<!-- Mobile navigation buttons -->
187+
188+
189+
<div style="clear: both"></div>
190+
</nav>
191+
</div>
192+
</div>
193+
194+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
195+
196+
</nav>
197+
198+
</div>
199+
200+
201+
202+
203+
<script>
204+
window.playground_copyable = true;
205+
</script>
206+
207+
208+
<script src="elasticlunr.min.js"></script>
209+
<script src="mark.min.js"></script>
210+
<script src="searcher.js"></script>
211+
212+
<script src="clipboard.min.js"></script>
213+
<script src="highlight.js"></script>
214+
<script src="book.js"></script>
215+
216+
<!-- Custom JS scripts -->
217+
218+
219+
</div>
220+
</body>
221+
</html>

‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pgosm-flex.com

‎FontAwesome/css/font-awesome.css

+4
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.

‎FontAwesome/fonts/fontawesome-webfont.eot

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)