Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create docs and configure settings #6

Closed
PhilipDeegan opened this issue Sep 29, 2016 · 11 comments
Closed

Create docs and configure settings #6

PhilipDeegan opened this issue Sep 29, 2016 · 11 comments

Comments

@PhilipDeegan
Copy link
Member

Pretty sure we can use a docs folder in the master branch, should
https://help.github.com/articles/user-organization-and-project-pages/

https://github.com/sparsehash/sparsehash-c11/tree/master/docs/index.html
could be accessible from
https://sparsehash.github.io/sparsehash-c11

See: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/

@donovanhide
Copy link
Contributor

Want to move the docs across and see if the urls work? Didn't know about the docs folder feature, very useful!

Additionally we could consider porting the docs to markdown from HTML and see if that works with this scheme?

I guess the real question that comes up from this is that Google searches for sparsehash will probably end up coming to the C++11 repo, which means we need to have a long think about how to explain the fork from the old repo. Are we planning to merge this repo back into the old repo at any point? Or is this a fork, for which we support in terms of packages for brew/apt/etc.? In which case we need to choose a non-clashing name for the include path.

@PhilipDeegan
Copy link
Member Author

Will do, I don't have the permissions (I believe) to configure the settings for gh-pages as noted in the links though.

I'm in favor of promoting this to the official version, and letting https://github.com/sparsehash/sparsehash become legacy.

The question arises, should the changes made by @greg7mdp be merged in, does it make sense to?

@donovanhide
Copy link
Contributor

donovanhide commented Sep 30, 2016

You have write permissions, don't you? Only one above is that is admin, for adding more people.

I think the gh-pages branch is not needed if we just create the docs folder?

Yep, we should apply all the patches from the main repo to this one. Are you volunteering? :-)

@donovanhide
Copy link
Contributor

Ahh, do you mean the /docs option in the settings is greyed out? I think that is just because the docs folder does not yet exist?

@PhilipDeegan
Copy link
Member Author

this

I can't do 3/4/5

@donovanhide
Copy link
Contributor

Tip: The master branch /docs folder source setting will not appear as an option if the /docs folder doesn't exist on the master branch.

@PhilipDeegan
Copy link
Member Author

PhilipDeegan commented Sep 30, 2016

I've added a temporary index.html under /docs

I don't have access to change the settings, if you would please.

I'll merge in the changes too

@donovanhide
Copy link
Contributor

Admin rights assigned :-) Github has a very confusing ACL system...

@PhilipDeegan
Copy link
Member Author

Ahah, thanks.

Success

@PhilipDeegan
Copy link
Member Author

#9

@PhilipDeegan
Copy link
Member Author

To update docs with link to gh-pages and with modified include path mentioned in #8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants