boost/unordered-ui-bundle
2
0
Fork 0
mirror of https://github.com/boostorg/unordered-ui-bundle.git synced 2026-01-19 04:42:15 +00:00
Code Issues Projects Releases Wiki Activity

update terminology for referring to the default branch

Browse Source
This commit is contained in:
Dan Allen
2021-10-06 03:10:02 -06:00
parent 318b429c68
commit ec2bd39379
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/modules/ROOT/pages/development-workflow.adoc
View File

@@ -2,7 +2,7 @@
// This section provides information about some of the UI files you'll be modifying and how to prepare and submit those changes.
All changes pushed to a UI project's master branch can trigger a new release (not described here).
All changes pushed to a UI project's default branch can trigger a new release (not described here).
Therefore, you want to make your changes to a development branch and submit it as a pull request (PR) to be approved.
(Even better would be to issue the PR from a fork).
Only when the PR is approved and merged will the new release be triggered.
@@ -11,7 +11,7 @@ Only when the PR is approved and merged will the new release be triggered.
Use the following command to create a local development branch named `name-me`:
$ git checkout -b name-me -t origin/master
$ git checkout -b name-me -t origin/HEAD
You'll then apply your changes to the UI files.
Once you're done making changes, commit those changes to the local branch:
@@ -26,6 +26,6 @@ Finally, navigate to your UI project in your browser and create a new pull reque
The maintainer of the UI should review the changes.
If the changes are acceptable, the maintainer will merge the pull request.
As soon as the pull request is merged into master, an automated process will take over to publish a new release for the site generator to use.
As soon as the pull request is merged into the default branch, an automated process will take over to publish a new release for the site generator to use.
Now that you've got the process down, let's review some of the files you'll be working with in more detail.

10
docs/modules/ROOT/pages/index.adoc
View File

@@ -71,15 +71,15 @@ The most common postprocessor backports newer CSS features to older browsers by
== UI project versus UI bundle
The [.term]*UI project*, the master branch of a git repository, contains the recipe and raw materials for creating an Antora UI bundle.
The [.term]*UI project*, which is comprised of the source files in the git repository, provides the recipe and raw materials for creating an Antora UI bundle.
It includes a build, source files, project files, and dependency information.
This is your development workspace.
The [.term]*UI bundle*, a distributable archive, provides pre-compiled (interpreted, consolidated, and/or minimized) files that are ready to be used by Antora.
=== UI project repository structure (master branch)
=== UI project repository structure (default branch)
You should think of the UI project's master branch as your UI workspace.
You should think of the UI project's default branch as your UI workspace.
It contains the recipe and raw materials for creating a UI, including a build, source files, project files, and dependency information.
Here's how the files are structured in the UI project:
@@ -133,7 +133,7 @@ The UI bundle--a distributable archive--provides files which are ready to be use
When the UI project files are built by Gulp, they are assembled under the [.path]_public_ directory.
Since the [.path]_public_ directory is generated, it's safe to remove.
The contents of the UI bundle resembles the UI project's master branch contents, except the bundle doesn't contain any files other than the ones that make up the UI.
The contents of the UI bundle resembles the UI project's default branch contents, except the bundle doesn't contain any files other than the ones that make up the UI.
This is the content that is used by Antora.
[.output]
@@ -174,7 +174,7 @@ The purpose of an Antora UI project is to get the UI files into a state that Ant
The UI is served statically in a production site, but the UI's assets live in a source form in a UI project to accommodate development and simplify maintenance.
When handed off to the Antora pipeline, the UI is in an interim, pre-compiled state.
Specifically, the master branch of the git repository contains the files in source form while releases are used to distribute the files in pre-compiled form.
Specifically, the default branch of the git repository contains the files in source form while releases are used to distribute the files in pre-compiled form.
The responsibility of compiling the UI is shared between a UI project and Antora.
The UI project uses a local build to pre-compile (i.e., interpret, consolidate, and/or minimize) the files.

2
preview-src/ui-model.yml
View File

@@ -62,7 +62,7 @@ page:
displayVersion: '5.2'
module: ROOT
relativeSrcPath: index.adoc
editUrl: http://example.com/project-xyz/blob/master/index.adoc
editUrl: http://example.com/project-xyz/blob/main/index.adoc
origin:
private: false
previous: