update doc

This commit is contained in:
André Roth
2024-11-28 13:09:41 +01:00
parent 83f7c869f0
commit 4f229a5bcf
18 changed files with 47 additions and 77 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
# Aptly Database Operations
# Maintenance Operations
<div>
Manage aptlys internal metadata database and package pool.
</div>
+1 -1
View File
@@ -1,4 +1,4 @@
# File Operations
# Upload Package Files
<div>
Upload package files temporarily to aptly service. These files
could be added to local repositories using [local repositories API](/doc/api/repos).
-4
View File
@@ -1,4 +0,0 @@
# GPG Keys
<div>
</div>
-30
View File
@@ -1,30 +0,0 @@
# Dependency Graph
<div>
aptly generates graph showing dependencies between mirrors, local repositories,
snapshots and published repositories.
 
Command graph generates graph of dependencies:
* between snapshots and mirrors (what mirror was used to create each snapshot)
* between snapshots and local repos (what local repo was used to create snapshot)
* between snapshots (pulling, merging, etc.)
* between snapshots, local repos and published repositories (how snapshots were published).
Graph is rendered to PNG file using graphviz package.
Usage:
$ aptly graph
Flags:
- `-format="png"`: graph output format, could be anything graphviz supports, e.g. `png`, `pdf`, `svg`, ...
- `-output=""`: specify output filename, default is to open result in viewer
- `-layout="horizontal"`: change between a `horizontal` and a `vertical` graph layout.
Example:
<a href="../../../img/graphfull.png"><img src="../../../img/graph.png" alt="Example graph from aptly graph (horizontal)" class="img-responsive"></a>
</div>
+4 -3
View File
@@ -1,7 +1,8 @@
# Repository Mirrors
# Remote Repository Mirrors
<div>
aptly allows to create mirrors of remote Debian repositories, HTTP, HTTPS and FTP repositories are supported.
Manage mirrors of remote Debian repositories.
HTTP, HTTPS and FTP repositories are supported.
Mirrors are created with [`aptly mirror create`](/doc/aptly/mirror/create/) command, mirror contents are downloaded with [`aptly mirror update`](/doc/aptly/mirror/update/) command. Mirror could be updated at any moment. In order to preserve current mirror state, [create snapshot](/doc/aptly/snapshot/create/) of the mirror. Snapshot could be published or used to build other snapshots.
</div>
+1 -1
View File
@@ -1,4 +1,4 @@
# Packages
# Search Packages
<div>
Perform operations on the whole collection of packages in apty database.
</div>
+1 -1
View File
@@ -1,4 +1,4 @@
# Aptly Publish Points
# Publish repositories and mirrors
<div>
Publish snapshot or local repo as Debian repository which could be served by HTTP/FTP/rsync server. Repository is signed by user's key with GnuPG. Key should be created beforehand (see section GPG Keys below). Published repository could be consumed directly by apt.
+1 -1
View File
@@ -1,4 +1,4 @@
# Repositories
# Manage Local Repositories
<div>
Local repository is a collection of packages (most usually custom packages created internally).
Packages could be added to local repository at any moment, removed, moved or copied between repos.
-5
View File
@@ -1,5 +0,0 @@
# S3 Endpoints
<div>
</div>
+1 -1
View File
@@ -1,4 +1,4 @@
# Repository and Mirror Snapshots
# Manage repository and mirror Snapshots
<div>
Snapshot is a fixed state of remote repository mirror or local repository. Internally snapshot is list of references to packages. Snapshot is immutable, i.e. it cant be changed since it has been created. Snapshots could be merged, filtered, individual packages could be pulled, snapshot could be verified for missing dependencies. Finally, snapshots could be published as repositories.
</div>
+1 -6
View File
@@ -1,10 +1,5 @@
# Aptly Status Information
<div>
## Something
Very interesting ... asd wer
Various status information.
</div>
+5 -1
View File
@@ -39,6 +39,11 @@
font-size: 16pt !important;
}
/* Group Spacing */
.swagger-ui .opblock-tag-section {
padding-top: 40px !important;
}
/* Tag Group */
.swagger-ui .opblock-tag-section > .opblock-tag > a {
color: grey !important;
@@ -51,7 +56,6 @@
.swagger-ui .opblock-tag-section .opblock-tag .markdown > h1 {
font-size: 14pt;
margin-top: 0px;
margin-left: 1em;
}
/* Group Description */
+3 -9
View File
@@ -10,24 +10,18 @@ package docs
// @Tag.description.markdown
// @Tag.name Files
// @Tag.description.markdown
// @Tag.name Packages
// @Tag.description.markdown
// @Tag.name Mirrors
// @Tag.description.markdown
// @Tag.name Snapshots
// @Tag.description.markdown
// @Tag.name Publish
// @Tag.description.markdown
// @Tag.name Graph
// @Tag.description.markdown
// @Tag.name S3
// @Tag.description.markdown
// @Tag.name GPG
// @Tag.description.markdown
// @Tag.name Database
// @Tag.name Packages
// @Tag.description.markdown
// @Tag.name Status
// @Tag.description.markdown
// @Tag.name Database
// @Tag.description.markdown
// @Tag.name Tasks
// @Tag.description.markdown