Skip to content

Comments

Migrate wiki into project#695

Merged
homu merged 118 commits intonew-xkit:masterfrom
0xazure:migrate-wiki
Dec 3, 2015
Merged

Migrate wiki into project#695
homu merged 118 commits intonew-xkit:masterfrom
0xazure:migrate-wiki

Conversation

@0xazure
Copy link

@0xazure 0xazure commented Oct 30, 2015

Move wiki documentation into a project subfolder docs/.

Closes #635.

@0xazure
Copy link
Author

0xazure commented Oct 30, 2015

I would be open to discussion regarding the series of commits from the wiki repository history, given how many of them there are.

Post-merge TODOs:

  • Clean out wiki repository & redirect to docs/ OR remove wiki entirely (via GitHub project settings)

@invalidCards
Copy link
Member

@0xazure Might be an idea to just squash it all under the header of "Merges wiki into main project"

@Wolvan
Copy link
Member

Wolvan commented Oct 30, 2015

I agree with @ThePsionic

@0xazure
Copy link
Author

0xazure commented Oct 30, 2015

I suppose the question would be if we care at all about the edit history of the wiki files. There's a few more recent ones that should probably be kept in the history, like pretty much anything after new-xkit took over.

@invalidCards
Copy link
Member

I personally don't really care about the edit histories of the wiki.

@hobinjk
Copy link

hobinjk commented Oct 31, 2015

I don't mind having the edit history available. It's nice to see who to blame for writing specific lines, especially if those lines appear to be wrong.

@nightpool
Copy link
Member

  • we should keep histories
  • they would show up in git log basically when they were created right? because default order is reverse chronological?
  • I'm down with removing the wiki altogether but we should make sure that the docs get into our gh-pages in rendered format somehow eventually.

@0xazure
Copy link
Author

0xazure commented Nov 1, 2015

show up in git log basically when they were created

I believe so, yes. They won't all get pushed to the top of the history if this is merged.

make sure that the docs get into our gh-pages in rendered format somehow eventually

Not sure I follow with this. @nightpool you mean you'd like to see all docs/**/*.md files added to gh-pages as HTML-rendered files? I'm not sure I see the need for this, given that Markdown is pretty readable in its own right. GitHub will also automatically render any pages you view in the web UI, so seeing HTML-formatted documentation pages would be as simple as viewing the docs/ folder on GitHub.

@bvtsang bvtsang self-assigned this Nov 14, 2015
@0xazure
Copy link
Author

0xazure commented Nov 14, 2015

@nightpool still waiting on a reply for the above.

@nightpool
Copy link
Member

Must have totally missed that reply around the end of the term.

I'm fine to merge for now I was more thinking about long term stuff.
On Fri, Nov 13, 2015 at 8:29 PM 0xazure notifications@github.com wrote:

@nightpool https://github.com/nightpool still waiting on a reply for
the above.


Reply to this email directly or view it on GitHub
#695 (comment).

@0xazure
Copy link
Author

0xazure commented Nov 14, 2015

I see most of the documentation in this PR being eventually superseded by generated JSDoc documentation, which we would want to host through gh-pages. This is more an effort to get the docs in sync with the project as a whole; we can evaluate how we want to handle new documentation on more recent pieces of the codebase separately.

@nightpool
Copy link
Member

Yeah definitely. Didn't mean to confuse this pr with my long term
speculation.
On Fri, Nov 13, 2015 at 9:08 PM 0xazure notifications@github.com wrote:

I see most of the documentation in this PR being eventually superseded by
generated JSDoc http://usejsdoc.org/ documentation, which we would want
to host through gh-pages. This is more an effort to get the docs in sync
with the project as a whole; we can evaluate how we want to handle new
documentation on more recent pieces of the codebase separately.


Reply to this email directly or view it on GitHub
#695 (comment).

@bvtsang
Copy link

bvtsang commented Dec 3, 2015

LGTM, thank you very much!

@homu r+

@homu
Copy link

homu commented Dec 3, 2015

📌 Commit aec9a54 has been approved by bvtsang

@homu
Copy link

homu commented Dec 3, 2015

⌛ Testing commit aec9a54 with merge a1f8e42...

homu added a commit that referenced this pull request Dec 3, 2015
Migrate wiki into project

Move wiki documentation into a project subfolder `docs/`.

Closes #635.
@homu
Copy link

homu commented Dec 3, 2015

☀️ Test successful - status

@homu homu merged commit aec9a54 into new-xkit:master Dec 3, 2015
@0xazure 0xazure deleted the migrate-wiki branch June 27, 2016 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.