Giter Club home page Giter Club logo

sdp-docs's Introduction

Solutions Delivery Platform Documentation

Antora

This repository contains documentation for the Solutions Delivery Platform (SDP) that does not belong to any particular component of SDP.

As such, it also serves as the Antora playbook repository.

Building the Docs

From the root of this repository, run make docs to build the documentation locally. Once finished, the static files will be in the docs directory.

Build Details

We make some custom modifications to Antora's site generation pipeline.

antora-lunr is used to enable the documentation's search functionality.

This package hard-codes the query selector's used to find a page's headers.

Given the changes that have been made for the UI Bundle, we had to customize the index generation process for lunr. This can be found in resources/generator/lib.

sdp-docs's People

Contributors

boydj avatar cokieffebah avatar darth-kermit avatar dzmitrytarasevich avatar jaredzieche avatar jaustin-bah avatar jpke avatar kottoson avatar kottoson-bah avatar nalexiou avatar normalfaults avatar psig-bah avatar salt-mountain avatar seb-bah avatar sheppard-brandon-bah avatar shoar avatar steven-terrana avatar tsteph11 avatar willkjackson avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

sdp-docs's Issues

Getting error in "Validate Jenkins" chapter of the tutorial when first build working with WSL2.

Hi. I'm getting this error when trying to run first build in the "Validate Jenkins" chapter of the Templating Engine tutorial:

[JTE] Obtained Pipeline Template from job configuration
Running in Durability level: MAX_SURVIVABILITY
[Pipeline] Start of Pipeline
[Pipeline] node
Running on Jenkins in /var/jenkins_home/workspace/validate
[Pipeline] {
[Pipeline] isUnix
[Pipeline] sh

  • docker inspect -f . maven

The command 'docker' could not be found in this WSL 2 distro.
We recommend to activate the WSL integration in Docker Desktop settings.

See https://docs.docker.com/docker-for-windows/wsl/ for details.

[Pipeline] isUnix
[Pipeline] sh

  • docker pull maven

The command 'docker' could not be found in this WSL 2 distro.
We recommend to activate the WSL integration in Docker Desktop settings.

See https://docs.docker.com/docker-for-windows/wsl/ for details.

[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
ERROR: script returned exit code 1
Finished: FAILURE

I'm having various wsl distros, even wsl1 and wsl2. But my default wsl distro is setting to one wsl2 valid one (in fact, the jenkins where i'm running the tutorial is executing in a docker container launched from that wsl2 distro -Ubuntu-20.04 for reference-.

Learning Lab for Jenkins IaC/CaC

It would be very helpful to have a learning lab that walks through how to containerize Jenkins and set it up so that the instance comes up preconfigured using:

Plugin Installation: installed during container build time
Jenkins Server Configs: configured using Jenkins Configuration as Code (JCasC)
Job Configurations: Created using Job DSL and invoked from the JCasC file
Everything Else: for things that can’t be easily configured using Job DSL or JCasC, use System Groovy Scripts invoked from JCasC

This learning lab should show how to take the upstream Jenkins community image and customize it for use with SDP:

  1. Show how to manually configure a Jenkins instance (plugin installs, instance configs, job configs)
  2. Show how to automate that manual configuration by extending the community container image with the strategies outlined above

Remote Docs Not Updating Properly

I noticed that when deploying the docs locally the JTE docs weren't updating properly. The only file in pages/jte/docs/pages was installation.rst, while the folders like Governance and Library Templating were missing. This was after running make docs, make live, and make get-remote-docs

I think it has to do with Git being reluctant to update the local Head if doing so would overwrite local changes. One solution that seemed to work for me is to update line 34 of the make file (and maybe line 30, too), changing git checkout master to git checkout remotes/origin/HEAD (or maybe remotes/origin/master) so that the update comes from the remote repository, and not the local copy.

@steven-terrana does that sound good?

cd pages/jte && git checkout master -- docs && cd -

Provide docs for a headless out-of-the-box docker Jenkins for tests

I'm in the process of investigating a bug of Jenkins template engine and am building a SSCCE for use case. I stumbled over The 'local development' section of the docs which describes the setup of a test Jenkins which requires a lot of manual configuration and provides a UI which is of no use for the case a simple reproducer for a bug.

It'd be nice to have instructions and a ready docker container for a one liner which allows to test the local pipeline and prints the job logs from a mounted volume.

Typo in learning lab

image

Should read: "Learn the different types of jobs available in Jenkins and when to use them"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.