Commit Graph

73 Commits

Author SHA1 Message Date
Marcin Grzejszczak
992b69d2f9 Added callout icons, fixes gh-70 2018-03-09 12:57:56 +01:00
Marcin Grzejszczak
09317bb95c Polish 2017-08-31 14:27:44 +02:00
Marcin Grzejszczak
8f19618cc2 Let's eat our own dogfood
sc-build reuses sc-build logic to generate its own docs
2017-08-31 14:08:45 +02:00
Marcin Grzejszczak
4d0246d73e Started to publish the docs module as a jar
without this change we copy paste all the scripts, resources etc. to every single project
with this change each project will have this project's resources unpacked in the local `target` directory. The docs generation already reference this changed location so no need to copy paste of any resources is required

fixes #60
2017-08-31 13:48:43 +02:00
Marcin Grzejszczak
0269b4a8b6 Not failing the script if a file can't be added
it happens when you want to add a file that is in .gitignore
2017-08-29 14:33:21 +02:00
Marcin Grzejszczak
b7bbf68141 Initial approach to new docs (#59) 2017-08-29 09:52:29 +02:00
Jon Schneider
de403a2553 Add CircleCI badge to README.adoc 2017-05-11 13:14:12 -05:00
Marcin Grzejszczak
736d29ac18 Fixed the retrieval of current branch 2017-03-17 10:10:08 +01:00
Marcin Grzejszczak
ef8189dc88 Fixed the retrieval of current branch 2017-03-17 09:43:26 +01:00
Marcin Grzejszczak
03fd279df1 Added logging to the script 2017-03-10 16:53:19 +01:00
Marcin Grzejszczak
3bfe13c793 Updated ghpages 2017-03-10 16:48:13 +01:00
Marcin Grzejszczak
931e8fe555 Updated ghpages 2017-03-10 16:00:12 +01:00
Marcin Grzejszczak
88118aa277 Don't switch to tag for snapshots 2017-03-10 15:36:59 +01:00
Pei-Tang Huang
9665f34a7f Fixed the format of JCenter deploying snippet. 2017-02-15 09:06:06 +08:00
copa2
c80858652b Fix typo
Obvious fix
2016-11-02 22:42:52 +01:00
Marcin Grzejszczak
786ffe9db5 Fixing git remote 2016-10-18 15:50:56 +02:00
Marcin Grzejszczak
3abc7bdef4 Added tail to pick proper echoed value 2016-09-22 22:58:45 +02:00
Dave Syer
26a0e7df3d Fix commented out git push
Otherwise the result is not persisted
2016-09-22 12:03:14 +01:00
Dave Syer
96e92e5dd4 Fix project name and git additions
The project name is not necessarily the same as the artifactId
(some projects use *-parent), so it's better to guess from
the git remote.

Also "git add -A <a file>" can easily fail if you add an ignored
file by mistake. It's better just to add the directory.
2016-09-22 11:15:35 +01:00
Dave Syer
c68034276a Update ghpages script to do project name discovery
Also uses local mvnw wrapper if it it is there.
2016-09-21 11:50:26 +01:00
Marcin Grzejszczak
74e01e91c7 Added ReleaseTrain switch 2016-08-23 16:01:53 +02:00
Marcin Grzejszczak
31b59823a2 Fixed bugs in gh-pages
- when (-b) flag was passed there was a check if target contains docs (makes no sense)
- after cloning the Spring Cloud Static we didn't check out gh-pages
2016-08-22 13:27:11 +02:00
Marcin Grzejszczak
66bfb4626b Added automated building and cloning of spring-cloud-static 2016-08-19 11:40:58 +02:00
Marcin Grzejszczak
2a24b23f37 Continuing the script when failing to check out... it happens for Jenkins for some reason 2016-08-18 16:45:45 +02:00
Marcin Grzejszczak
fa67b987a3 Continuing the script when failing to check out... it happens for Jenkins for some reason 2016-08-18 16:10:50 +02:00
Marcin Grzejszczak
9726d21b93 Fixed branch resolution
some older repos don't have the docs.main prop. In that case I'm resolving the root file from REPO_NAME
2016-08-18 14:26:36 +02:00
Marcin Grzejszczak
8cec662d57 Added cd to rootfolder for ghpages 2016-08-18 13:43:09 +02:00
Marcin Grzejszczak
bc15dd4cf9 Updated synchro script - fixed minor bugs 2016-08-18 13:17:04 +02:00
Marcin Grzejszczak
1c8c65b384 Creating folder in ghpages only when branch is whitelisted 2016-08-18 12:54:07 +02:00
Marcin Grzejszczak
990f3bcca3 Reverting back to previous logic of docs copying 2016-08-18 12:45:18 +02:00
Marcin Grzejszczak
d9ab4d4172 Fixed the invalid destination folder for docs 2016-08-18 12:40:20 +02:00
Marcin Grzejszczak
8d7ee9f53a Fixed the wrong script 2016-08-18 12:32:55 +02:00
Marcin Grzejszczak
6ad3ddf539 Updated the gh-pages script to deploy from a tag to given folder 2016-08-18 12:05:15 +02:00
Marcin Grzejszczak
9b126f55ca Added ghpages synchronization script
we have a lot of projects that have ghpages.sh file in different branches. This script will allow to update all of them in a relatively easy way
2016-08-17 12:48:06 +02:00
Marcin Grzejszczak
e6b32406dc Hopefully fixed the build for Jenkins 2016-08-16 17:58:07 +02:00
Marcin Grzejszczak
8b482cd8c6 Updated the gh-pages script with path to Maven 2016-08-16 17:52:29 +02:00
Marcin Grzejszczak
0e710b4095 Updated the gh-pages script 2016-08-16 17:42:02 +02:00
Marcin Grzejszczak
7b77bdaf33 Deploying documentation to proper folder
What we're missing ATM is different documentation versions for different application versions. What this change does is that it's:

- finding out what is the current branch (e.g. 1.0.x)
- finding out out what is the name of the main adoc file (e.g. spring-cloud-sleuth)
- pulling the changes from gh-pages after checkout
- finding out what is the list of comma separated whitelisted branches (via the `docs.whitelisted.branches` prop)
- in gh-pages creating a folder with name of the branch  (e.g. /1.0.x)
copying all the docs/target/generated-docs/ to that folder
- if the branch from which we're calling the script is NOT master then we're changing the ${main.adoc}.html to index.html so that it's easier to access the docs (e.g. http://cloud.spring.io/spring-cloud-sleuth/1.0.x/)
2016-08-16 15:53:24 +02:00
Dave Syer
8c3e4b80e0 Change link to CLA 2016-07-11 09:18:53 +01:00
Dave Syer
a0e769b05d Update readme script to handle local includes 2016-06-11 09:55:16 +01:00
Dave Syer
4e005c6ec9 Add note on Maven version for other IDEs 2016-05-12 10:38:23 +01:00
Dave Syer
1415e7aeb3 No more .settings.xml 2016-05-12 10:26:59 +01:00
Dave Syer
06cae07c63 Re-org the building docs (lombok is not the default) 2016-05-12 10:12:43 +01:00
Marcin Grzejszczak
80e7b04808 Added no-lombok document 2016-03-08 18:36:02 +01:00
Marcin Grzejszczak
97c71e80c9 Adding the lombok section as conditional
In Sleuth for instance it will be enough to import this and provide

```
:no_lombok:
```

at the beginning of the asidoc file.
2016-03-08 17:27:24 +01:00
Spencer Gibb
ed8d17e5ae Update readme for code of conduct.
See gh-26
2016-02-01 20:26:34 -07:00
Spencer Gibb
d7d67bf9bf Fixed formatting 2016-02-01 19:57:45 -07:00
Spencer Gibb
34c4dfc5be Updated link to code of conduct.
fixes gh-26
2016-02-01 19:57:10 -07:00
Spencer Gibb
b799464b69 Added code of conduct and fixed eclipse link.
fixes gh-26
2016-02-01 19:55:34 -07:00
Dave Syer
8ca2eec906 Revert profile and add comment 2015-10-20 09:34:47 -04:00