Giter VIP home page Giter VIP logo

docs-as-co.de's Introduction

docs-as-co.de's People

Contributors

ahus1 avatar anoff avatar chrira avatar dependabot[bot] avatar der-ambi avatar gernotstarke avatar ghp-dev avatar rdmueller avatar xell1986 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

docs-as-co.de's Issues

add content to "get-started"

[] quickstart: use gradle (siehe Kolumne Folge 1)
[] I cannot use gradle: use Docker (to be done)
[] I like it, I want the full package: use docToolchain
[] Additional options: PlantUML, EnterpriseArchitect(tm), Confluence(tm), ... (to be done)

contact email points to [email protected]

Ralf, I assume you want the email to point to your gmail address?

You could configure a mail forward with the docs-as-co.de domain...
but our personal addresses would be ok for me too

Fix some typos in tutorial1

The tutorial under
https://github.com/docToolchain/docs-as-co.de/blob/master/docs/_pages/getstarted/
contains some minor issues.
E.g.

  • typo
mkdir tutorial1 
cd tutorial

the last command is missing a '1'

  • file overwrite
    gradle initproduces a nice settings.gradle file (in folder tutorial1). The next command echo "include 'docToolchain'" > settings.gradle overwrites it's content with the one-liner.
    append the 'include' statement with >>

  • runtime errors due to uncommented line numbers

page excerpt on "getting started" is not readable

white on light-gray image is not readable...

Either use a dark image, or a more compact "slug" (my suggestion).

As the existing "summary" is nice, we could move it to a "quotation" on the page itself"

htmlSanityCheck

... is now included in the build :-)

... but we get lots of errors and warnings

... and when rc2 of HSC is out, the build has to be modified in order to check all files

try to publish the easy example to confluence

Hi there,

i would like to ask for assistance. It was very easy (and a nice experience, too โค๏ธ ) to follow the simple Tutorial on https://docs-as-co.de/getstarted --> The Build-Tool Approach --> Gradle.

calling the asciidoctor task (see below) created the test.html file

After having created the test.html file i wanted to publish that to confluence.

I researched the gradle plugin https://plugins.gradle.org/plugin/de.docs-as-co.publishToConfluence ... but i was not able to find out how to configure it. ... I also looked at http://doctoolchain.org/docToolchain/v2.0.x/015_tasks/03_task_publishToConfluence.html#_configuration ... and tried that ... but i am not doing it the right way ๐Ÿ˜ข

Could you/someone maybe answer with a (configured the right way way ๐Ÿคท โ‰๏ธ ) gradle task config for my build.gradle file for the following setup: (the part in the task asciidocToConfluence seems to be improvable ๐Ÿ˜… )

Thank you in advance, if you maybe be able to help me!

As an alternative: do you know any github repos that show a working setup for "publishing to confluence"? I then could look at that, and maybe repair it myself โœŠ

asciidoctor {
  //  sourceDir  file('docs/asciidoc')
  //  sources {
  //	include 'toplevel.adoc', 'another.adoc', 'third.adoc'
  //  }
  //  outputDir  file('build/docs/asciidoc')
}

asciidocToConfluence {
	
	input = [
		[ file: "build/docs/asciidoc/test.html" ],
	]
	
	// endpoint of the confluenceAPI (REST) to be used
	api = 'https://confluence.host.url/rest/api/'
	
	// the key of the confluence space to write to
	spaceKey = '$CONF_SPACE_KEY'
	
	// variable to determine whether ".sect2" sections shall be split from the current page into subpages
	createSubpages = false
	
	// the pagePrefix will be a prefix for each page title
	// use this if you only have access to one confluence space but need to store several
	// pages with the same title - a different pagePrefix will make them unique
	pagePrefix = 'Testtest - '
	
	// username:password of an account which has the right permissions to create and edit
	// confluence pages in the given space.
	// if you want to store it securely, fetch it from some external storage.
	// you might even want to prompt the user for the password like in this example
	
	credentials = "$user:$password".bytes.encodeBase64().toString()
}

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.