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

WHERE IS THE DOCUMENTATION! #1

Open
HazardJ opened this issue Sep 30, 2015 · 12 comments
Open

WHERE IS THE DOCUMENTATION! #1

HazardJ opened this issue Sep 30, 2015 · 12 comments

Comments

@HazardJ
Copy link
Member

HazardJ commented Sep 30, 2015

Per @dazzaji and everyone else, this looks promising, but how does it work??

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

Per @dazzaji:

  1. go to settings in the repository
  2. scroll down to GitHub Pages and select "automatic page publisher"
  3. choose a template an be sure to hit "publish site" as last step.
  4. note that github made a new "GitHub Pages" branch in your repo and auto provision an html5 site based on your markdown in the auto publisher. How nice!
    Also note that GitHub generated a URL in the following format for you: http://decentlaw.github.io/Codification_Conference.
  5. to update the content or replace it just change files IN THAT BRANCH of the repo. Not the master branch. Only that branch serves web pages.
  6. to point a custom domain at your site, just add to the root directory of the pages branch a file named "CNAME" (all caps, no file type but it is plain text of course) and include in the body of the file just the domain name in full (ie the following characters in quotes "http://example.com"). Then add the IP addresses for GitHub to the A-Name DNS entry at the registrar of wherever you got your domain name. If you need help with that let me know (or just google github "custom domain" and "github pages" and you will quickly spot tutorials etc on how to do that). IT IS FREEEEEE!

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

Per @HazardJ OK, I'll try that.

  1. "automatic page publisher" = "Launch automatic page publisher"
  2. I selected "Minimal"
  3. Cool! I didn't know about this use of branches.
  4. Is now available at: http://commonaccord.github.io/Cmacc-Startup2/. NOTE - it is Case-SensiTive. This suggests it would be good to do some more thinking about the exact name. footnote1

footnote1:
And think about decentlaw/commonaccord. I'm now thinking that this repo (Cmacc-Startup2) is destined to become the canonical repo - the "real" CommonAccord. The naming scheme for GH/ and W/ seems to resolve the problem of contributor coordination at least to a level of MVC (minimum viable collaboration). (As separate Issue will put an email conversation with @zmon about naming these folders.) As discussed with @dazzaji, am totally open to decentlaw, as a way of signaling an effective (as opposed to merely desired) communalization of the effort.

@mdangear
Copy link
Contributor

Tried to follow instructions, created a branch gh_pages, and I added a file https://github.com/CommonAccord/Cmacc-Startup2/blob/gh-pages/BB_NDA_Core.md but I am not seeing anything about decentlaw.github.io there. Not sure whether this is for me to use or not, I thought that this was a way to start contributing docs, but maybe I missed something.

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

Cool, @mdangear! Parallel collaboration! Let's try to merge.

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

@mdangear - yes idea is documentation, and I still don't know how it works. Will need some more instruction from @dazzaji. "Docs," if it means documents, could go in the repo at Doc/W/com/be-bound/ and then however you want (with a suggestion of a subfolder for the name of the document then one for the Form and one for the Sec tions. E.g., Doc/W/com/be-bound/ToU/Form/Doc_v01.md

@mdangear
Copy link
Contributor

From what I read the idea seems to be that each startup/contributor would create their own set of pages into a separate branch. What is not clear to me is how the pages then flow from branches back to master or the other way (in case I am interested in a specific form from master). But maybe I am missing something. I guess a typical use case would help clarify what this is for.

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

I think the branch is just for documentation - i.e., how to use the system, and I, too, don't understand it yet. The actual documents remain as before, no change.

@dazzaji
Copy link
Collaborator

dazzaji commented Sep 30, 2015

Hi guys. I'm confused about what you need help with. Can you hit me with your current open question(s) in this comment thread and we'll nail it down here.

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

Cool. First let me answer @mdangear with the part I understand. http://new.commonaccord.org/index.php?action=list&file=/Wx/com/be-bound/ is where you can put stuff.

Now - the part I don't understand is how we do documentation. I'm pressed now, but will come back.

@HazardJ
Copy link
Member Author

HazardJ commented Sep 30, 2015

@dazzaji - I'm having trouble even formulating a question. Perhaps you could add a page (or stub of a page) of something on the Pages part and it would begin to come into focus for me.

@dazzaji
Copy link
Collaborator

dazzaji commented Oct 1, 2015

Context: Jim and I were discussing how get hub conserve web pages in HTML format to standard web browsers. The excerpt Jim from me explains how to set up this capability, including how to create the web service and an initial HTML page and also the syntax with an example of an included URL for the public to reach your pages. The use cases this is a web server from which you can display HTML webpages to the public. This is not intended to be a high volume free website service from GitHub. Rather this is a courtesy to enable projects to have project pages without needing to go elsewhere to host them. However most projects never attain large audiences and this service has been invaluable for many projects I'm aware of and have been involved in. However most projects never attain large audiences and this service has been invaluable for many projects hey I'm aware of and have been involved in. If you want to directly connect the website pages branch to your workflow it is as easy as simply agreeing with whomever your collaborating with to use one or more different branches for staging and use the pages branch as your final appointment version of those files. This would be logical if your project was a website. If your project is C++ code then this would be not be a great fit for your deployment branch. Given the priority need for display of contract material, the integrated web service certainly seems to be a very close if not perfect fit for the general outcomes intended for users of contracts.

@mdangear
Copy link
Contributor

mdangear commented Oct 1, 2015

Excellent, thank you for the clarification. Makes sense, and clearly not something I need to be involved in actually. I will focus on synchronizing Be-Bound docs with the new Cmacc-Org repo instead.

HazardJ pushed a commit that referenced this issue Jun 11, 2016
Please accept my pull request.  If you like this, then please make a …
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

3 participants