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

Add Getting Started page #30

Merged
merged 1 commit into from
Jun 24, 2019
Merged

Add Getting Started page #30

merged 1 commit into from
Jun 24, 2019

Conversation

rnestler
Copy link
Member

@rnestler rnestler commented Jan 14, 2019

Fixes #25

First draft to get some feedback if this is how a getting started guide should look like. Personally I have the following comments:

  • The menu bar gets a bit cluttered. Should we split it into sub menus like:
    docs
       |-> API Reference
       |-> Getting Started
    
    or similar?
  • Should we provide static hosting examples on GitHub / GitLab? From an OSS perspective GitLab is probably preferable, but I'm writing this on GitHub, so... 😉

Rendered

@rnestler rnestler requested a review from a team January 14, 2019 20:08
@dbrgn
Copy link
Contributor

dbrgn commented Jan 14, 2019

Will GitHub / GitLab allow proper CORS headers?

That's something we'll have to discuss at the next telco tomorrow. I think it would be nice if all endpoints were queryable from the web. But it raises the bar for setting up an endpoint.

@rnestler
Copy link
Member Author

Will GitHub / GitLab allow proper CORS headers?

Probably not, but yes let's discuss it tomorrow.

@rnestler rnestler changed the title WIP: Add Getting Started page Add Getting Started page Jun 10, 2019
@rnestler
Copy link
Member Author

@SpaceApi/core I updated the guide. We can discuss it tomorrow at the meeting.

@rnestler
Copy link
Member Author

@dbrgn Can I merge this as is?

Copy link
Contributor

@dbrgn dbrgn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, thank you!

@rnestler rnestler merged commit 3931768 into master Jun 24, 2019
@rnestler rnestler deleted the add-getting-started-page branch June 24, 2019 11:52
@gidsi gidsi mentioned this pull request Aug 24, 2019
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

Successfully merging this pull request may close these issues.

Add getting started section
2 participants