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 A Static Website For The Project #7

Open
thealphadollar opened this issue Oct 8, 2020 · 6 comments
Open

Create A Static Website For The Project #7

thealphadollar opened this issue Oct 8, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation easy enhancement New feature or request hacktoberfest help wanted Extra attention is needed

Comments

@thealphadollar
Copy link
Owner

A static website with information about the project; examples, demos, how to set up, etc. The website would be hosted over Github pages.

Most of the information for the website can be taken from the README.md, however, the focus of the issue is creating a static website and not the actual content (which will be filled in by the maintainers).

@thealphadollar thealphadollar added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed hacktoberfest easy labels Oct 8, 2020
@josephcagle
Copy link

I have set up a simple GitHub Pages site (basically a copy of the README) in a gh-pages branch in my fork. Can you add a gh-pages branch in this repo so I can make a pull request?

@thealphadollar
Copy link
Owner Author

Hey, @DarthFloopy thanks for the initiative - as you said, I've added a new branch to the repository. Please raise a pull request.

@josephcagle
Copy link

Hmm... GitHub Pages uses a gh-pages branch with a totally separate file tree (composed of website files), so I can't make a PR comparing my gh-pages branch, which has four commits and a couple of files, to yours, which is just a copy of and has all the stuff from your actual project.
I don't know the best way to resolve this. Maybe you could delete your gh-pages branch and set it up again for GH Pages (using "Settings" > "Github Pages" or however), and then a PR would work. (I am fine with whatever you think works best)

@thealphadollar
Copy link
Owner Author

@DarthFloopy Github by default serves the README.md when a gh-pages branch is created. You can view it at http://thealphadollar.me/vanilla-i18n/ So, there are two steps we should be taking:

  1. Understanding how your work is different from the current serving of the README.md and how we can improve on it. We can do this by sharing the URL of your gh-pages.
  2. Base your work (once above is done) on the current gh-pages and put all the files in a folder. I'd then host the website from this folder instead of the root.

Does that sound good? Let me know your thoughts. The aim of this PR is to help you understand gh-pages and related steps, so hosting it yourself will help.

@josephcagle
Copy link

That sounds like it might work. My gh-pages branch is at https://github.com/DarthFloopy/vanilla-i18n/tree/gh-pages

However, at this time I don't think I am ready to do a lot more work on this. Hopefully, you can do something with what I have done already. (If you need me to make a PR or do something else like that, I can certainly do that.) Let me know if there's anything else you need me to do.
Thank you.

@thealphadollar
Copy link
Owner Author

thealphadollar commented Nov 12, 2020

@DarthFloopy Hey, I'm thankful for you working on this issue and serving the README.md. I should have mentioned in the issue itself that we can already serve the README.md file and hence serving it should be avoided. My bad, apologies.

Do you think it'll be wise to deploy your branch which does the same instead of using the default README.md serving? Maybe, if you are comfortable, we could look towards doing some changes and improvements as you get time and then merge it and redeploy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation easy enhancement New feature or request hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants