Skip to content
This repository has been archived by the owner on Dec 5, 2019. It is now read-only.

MOBDOC-14 Add Antora structure to xamarin repo for docs #37

Merged
merged 1 commit into from May 8, 2018

Conversation

pwright
Copy link
Contributor

@pwright pwright commented Apr 30, 2018

Motivation

Add antora structure to sdk for docs

JIRA: https://issues.jboss.org/browse/MOBDOC-14

@pwright pwright requested a review from wei-lee April 30, 2018 14:22
@wei-lee
Copy link
Contributor

wei-lee commented Apr 30, 2018

The changes look fine. Any particular instructions on how to verify the changes?

@pwright
Copy link
Contributor Author

pwright commented Apr 30, 2018

@wei-lee I have some instructions at http://shiftgear.org/processes/latest/docs/antora.html
but dunno if that helps

@wei-lee
Copy link
Contributor

wei-lee commented Apr 30, 2018

I followed the instructions and looks like it is working. Although I noticed that this is creating a new docs dir, even though there is already a Documentations dir in the SDK already. Is that necessary?

@pwright
Copy link
Contributor Author

pwright commented Apr 30, 2018

@wei-lee could I suggest that we have a follow on task, to convert the existing doc from markdown to asciidoc and include it in the docs directory?

@pwright
Copy link
Contributor Author

pwright commented Apr 30, 2018

@wei-lee btw you could assign that follow on task to me ;) We could reuse documentation directory, but would make this repo different from all the others, that's what i'm trying to avoid

@wei-lee
Copy link
Contributor

wei-lee commented Apr 30, 2018

@finp we have a task this sprint to actually starting on writing the docs. I think we can progress the follow on task as part of that issue. Are you ok with that?

@pwright
Copy link
Contributor Author

pwright commented Apr 30, 2018

@wei-lee perfect

@wei-lee
Copy link
Contributor

wei-lee commented Apr 30, 2018

@finp I have updated the description of the JIRA issue to include the follow on tasks you have mentioned.

@StephenCoady
Copy link
Contributor

@wei-lee @finp by the sounds of it this is done. can we merge it?

@wei-lee
Copy link
Contributor

wei-lee commented May 8, 2018

@StephenCoady I am ok to merge this if @finp is happy with it.

@StephenCoady StephenCoady self-requested a review May 8, 2018 08:47
Copy link
Contributor

@StephenCoady StephenCoady left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after a rebase this is good to merge. thanks @finp

@StephenCoady StephenCoady merged commit ab71523 into aerogear-attic:master May 8, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants