Skip to content
This repository has been archived by the owner on Oct 9, 2018. It is now read-only.

Refs #6272: update Javascript developer guide post Bastion. #18

Merged
merged 1 commit into from Jul 30, 2014
Merged

Refs #6272: update Javascript developer guide post Bastion. #18

merged 1 commit into from Jul 30, 2014

Conversation

waldenraines
Copy link
Contributor

No description provided.

@daviddavis
Copy link
Contributor

FYI, there are some things we need to do with this file (not sure if you'd be interested in doing this in this PR):

  1. Need to fix code highlighting. See Fixes #6579 - Fixing code blocks in our documentation #21
  2. We need to fix the file extension (should be md and not mkd)

@waldenraines
Copy link
Contributor Author

Need to fix code highlighting. See #21

#21 (comment)

We need to fix the file extension (should be md and not mkd)

Done.

@ehelms
Copy link
Member

ehelms commented Jul 14, 2014

@waldenraines do you think we should break out the JS docs into these different sections or silo it all under a Bastion heading?

@waldenraines
Copy link
Contributor Author

@ehelms what do you mean by "these different sections" and by "silo it all..." do you mean put a Bastion header up top or otherwise specify that this applies to Bastion only?

@ehelms
Copy link
Member

ehelms commented Jul 14, 2014

@waldenraines and/or create a section that houses all the Bastion specific documentation?

@waldenraines
Copy link
Contributor Author

@ehelms so move all of the bastion documentation here from https://github.com/katello/katello/tree/master/engines/bastion ?

@ehelms
Copy link
Member

ehelms commented Jul 15, 2014

@waldenraines sort of two questions:

  1. Should we just move all the Bastion documentation to these docs?
  2. How should we organize those documents? One file? A section with subsections?

@waldenraines
Copy link
Contributor Author

  1. Should we just move all the Bastion documentation to these docs?

We could, I'm good with that, at least that way they will be centralized.

  1. How should we organize those documents? One file? A section with subsections?

I think we should split them up because it is a wall of text.

@waldenraines
Copy link
Contributor Author

@ehelms updated.

@ehelms
Copy link
Member

ehelms commented Jul 24, 2014

Hrmm, the docs for these pages don't lay themselves out very logically. What about making a top level nav section for Bastion for now? And making the 'The Katello UI Engine' page essentially the index/first page?

@waldenraines
Copy link
Contributor Author

@ehelms updated.

@ehelms
Copy link
Member

ehelms commented Jul 30, 2014

I am seeing:

bastion_docs

@waldenraines
Copy link
Contributor Author

@ehelms updated.

@ehelms
Copy link
Member

ehelms commented Jul 30, 2014

Hrmm, I am getting

      Generating...   Liquid Exception: Included file '/home/ehelms/workspace/katello.org/_includes/sidebars/bastion.html' not found in _includes/{{page.sidebar}}, included in _layouts/base.html

@waldenraines
Copy link
Contributor Author

@ehelms guess it would help if I git add that file. Updated.

@ehelms
Copy link
Member

ehelms commented Jul 30, 2014

ACK

waldenraines pushed a commit that referenced this pull request Jul 30, 2014
Refs #6272: update Javascript developer guide post Bastion.
@waldenraines waldenraines merged commit 879128b into Katello:master Jul 30, 2014
@waldenraines waldenraines deleted the javascript branch July 30, 2014 20:32
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