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 an API-reference website #15

Closed
quicksketch opened this issue Oct 16, 2013 · 4 comments
Closed

Create an API-reference website #15

quicksketch opened this issue Oct 16, 2013 · 4 comments

Comments

@quicksketch
Copy link
Member

We should create an API website matching api.drupal.org, leveraging the API module to index our fork of the code.

Unlike Drupal's API website, I'd like to see the API website be the conical location for all API documentation, including:

So rather than being a read-only site, the API website actually is actually where documentation for Backdrop is created and stored.

I've already made an issue specifically for changelogs here: #14

@matt2000
Copy link

matt2000 commented Dec 5, 2013

Setting up an api module site is easy enough; I've done it before. Do you want it hosted on your infrastructure? Otherwise, I can put it on a server of my own and you can just point the sub-domain at my IP.

@quicksketch
Copy link
Member Author

@matt2000, that would be great if you're interested in setting it up! I'd like to keep our servers in a single place for management purposes. I'll get a box ready for you. You already have my e-mail, could you send me your public key? I'll add it to the utility server and we can set the API site up there.

@quicksketch
Copy link
Member Author

OK! @matt2000 I've set up a new repository and domain for you:

Repository: https://github.com/backdrop/api.backdropcms.org
Site: http://api.backdropcms.org/

You can connect to the box via:
ssh [email protected]

The web directory is already set up, MySQL credentials are in a file called "matt-MYSQL_LOGIN_INFORMATION.txt" ;)

Ideally, you'll push the code up into the Github repository, and make a clone of the repository on the server so we can update the site using Git.

@jenlampton
Copy link
Member

Since we now have an API site with it's own issue queue (https://github.com/backdrop/api.backdropcms.org/issues) I'm going to close this issue.

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