Skip to content

Quickstart: which tag for which system; a sitemap; /get_started/ answers #418

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.

Sign up for GitHub

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

Merged
oblomov-dev merged 1 commit into from
Nov 7, 2026
Merged

Quickstart: which tag for which system; a sitemap; /get_started/ answers #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/.vitepress/config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ export default defineConfig({
* The raw markdown is unaffected: publicDir copies the files regardless of
* whether they are also treated as pages. */
srcExclude: ["public/**"],
// /docs/sitemap.xml, one entry per page: the root's robots.txt
// (abap2UI5/abap2UI5.github.io) names it next to the sister sites' ones.
sitemap: { hostname: SITE_URL },
head: [
["link", { rel: "shortcut icon", href: "/docs/favicon.ico" }],
[
Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A finished app looks like any other UI5 app, because it is one — a selection s

![An abap2UI5 app: a selection form above a table of invoices, with a dialog editing one row](/tutorials/walkthrough-preview.webp)

→ *The [Tutorial](/tutorials/) grows exactly this app in ten steps, each one a complete class you can run in the browser — then takes it to production, and under unit tests*
→ *The [Tutorial](/tutorials/) grows exactly this app in twelve steps, each one a complete class you can run in the browser — then takes it to production, and under unit tests*

## Background
Since launching in 2023, abap2UI5 has grown from a small side project into a community-driven framework. The framework absorbs frontend complexity, so you can focus on business logic with your existing ABAP skills. Each app ships as an [abapGit](https://abapgit.org) project, so installation across systems needs no separate frontend deployment.
Expand Down
20 changes: 16 additions & 4 deletions docs/get_started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ No system at hand? Two ways to see abap2UI5 run before anything is installed:
framework in your browser: write ABAP on the left, watch the app run on the
right, nothing to install.
- The [**sample catalog**](https://abap2ui5.github.io/samples-site/)
lists over 700 working apps, each with its ABAP printed in full and a
lists hundreds of working apps, each with its ABAP printed in full and a
button that runs it - a live demo of every pattern the cookbook describes.

Both are also where to send a colleague who wants to see it before reading on.
Expand All @@ -35,9 +35,21 @@ Four things the three steps below assume:
## 1. Install the Framework via abapGit

Pull [abap2UI5](https://github.com/abap2UI5/abap2UI5) with
[abapGit](https://abapgit.org). For anything beyond a first look, pull a
[release](https://github.com/abap2UI5/abap2UI5/releases/) rather than `main` —
see [Productive Usage](/configuration/productive_usage) for why.
[abapGit](https://abapgit.org). Which branch or tag depends on the system:

| Your system | What to pull | Where it is explained |
| --- | --- | --- |
| ABAP 7.50 or newer, on premise or private cloud | The newest tag without a suffix, `X.Y.Z` - or `main` for a first look | [Versioning](/configuration/versioning) |
| ABAP 7.02 to 7.4x | The same version with the suffix `-702`, `X.Y.Z-702` - a downported build of the same release | [Downporting](/advanced/downporting) |
| BTP ABAP Environment or S/4 Public Cloud | The newest tag without a suffix, with abapGit for Eclipse | [S/4 Public Cloud](/configuration/s4_public_cloud) |

On the [releases page](https://github.com/abap2UI5/abap2UI5/releases/) every
version appears twice, once with the suffix and once without; the one GitHub
marks *Latest* is not the newer, only the one published last. In abapGit a tag
is chosen on the repository's page: *Branch* → *Switch* → *Tags*, or the tag
typed into the *Branch* field of the online repository. For anything beyond a
first look, pull a tag rather than `main` - see
[Productive Usage](/configuration/productive_usage) for why.

![abapGit repository installation screen for abap2UI5](/get_started/image.webp)

Expand Down
23 changes: 23 additions & 0 deletions docs/public/get_started/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!doctype html>
<!--
Redirect: /docs/get_started/ is a folder of pages and had no page of its
own, so the address every reader guesses - and the one search engines and
link previews shorten links to - answered 404. The Quickstart is where that
reader wanted to go.
-->
<html lang="en">
<head>
<meta charset="utf-8">
<title>Page moved - abap2UI5</title>
<link rel="canonical" href="https://abap2ui5.github.io/docs/get_started/quickstart">
<meta http-equiv="refresh" content="0; url=https://abap2ui5.github.io/docs/get_started/quickstart">
<meta name="robots" content="noindex">
<script>location.replace('https://abap2ui5.github.io/docs/get_started/quickstart' + location.hash);</script>
</head>
<body>
<p>
Getting started with abap2UI5 begins at the
<a href="https://abap2ui5.github.io/docs/get_started/quickstart" target="_self">Quickstart</a>.
</p>
</body>
</html>
Loading