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.

Sign up for GitHub

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

update readme sama as index page #30

Closed
wants to merge 1 commit into from
Closed

update readme sama as index page #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 11 additions & 118 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,127 +1,20 @@
README
======
# Kulkul.tech Open-source program

First things first
------------------

Learn [Markdown](https://help.github.com/articles/github-flavored-markdown)! Then check out MDwiki's [quick start](http://dynalon.github.io/mdwiki/#!quickstart.md).
## Welcome

Whenever you feel stuck, go to [MDwiki's own site](http://mdwiki.info) for further information.
Welcome! You're on Kulkul's open-source program page. We are committed to the open-source movement and using the open-source program as a tool to nurture and groom the next generation of Kul software engineers. We have internships and open-source programs that we started to open in late 2020. Browse around to learn more.

One Wiki Only? Fork It.
-----------------------
## About Kulkul.tech

First off fork this repo and call it something like `<MyProject>-wiki`.
Kulkul.tech is a software development firm committed to high-quality software development and engineering education. We're proud to be a remote-first company. Our team is distributed in various cities in Indonesia and South East Asia.

Multiple Wikis? Clone It.
-------------------------
## Internships Program

In case would you like to create more than one wiki for the same GitHub user or organization, then forking won't cut it. At the moment of this writing GitHub won't allow you to fork a single repository multiple times for the same account.
We're running our year-long internship program. If you're interested please reach follow our [Internship First Steps](pages/internship.md). Our program always opens throughout the year.

There's a workaround to this, however on GitHub's web interface you won't see the sign that says "forked from" in your cloned repository.
## Open-source Projects

Below instructions how to clone this repository using the CLI:

**First off, create a new (empty) repository on GitHub, then;**

```bash
git clone https://github.com/exalted/mdwiki-seed.git
cd mdwiki-seed
git remote add foobar <HTTPS/SSH Clone URL of the New Repository>
git push foobar gh-pages
```

Create a New Wiki
-----------------

It all begins by creating an initial file structure for any language that you would like to support. For example, if you're interested having a wiki in English, then you will duplicate `ll_CC` folder and rename your copy to `en`. (For a complete list of languages [`ll`] and country codes [`CC`] [see here](http://msdn.microsoft.com/en-us/library/ee825488).)

`ll_CC` is a starter template folder which you shouldn't ever edit directly, since you may loose your changes when MDwiki gets updated later.

> If you want to have your wiki in more than one language, then you duplicate `ll_CC` as many times as necessary and rename each copy with the appropriate language and country code. (Country code is optional and it is only useful if you want to distinguish, for instance, American English from British English, such as: `en_US` and `en_GB`.)

Getting Started
---------------

_You should have a language wiki folder by now, if not, go back and read above to create one._

Suppose your first wiki is going to be in English, hence you must have a folder called `en`, as previously described.

1. Open `index.html` file with your favorite plain text editor (the one that is at the same level where `ll_CC` and your language folder is located, **NOT the one inside your language folder**)
1. Find where it says "Override `ll_CC` below with your default language and country code"
1. Change refresh meta tag from `url=ll_CC/` to `url=en/` **(trailing `/` is very important)**

Structure
---------

_All file references here are relative to their respective language folder._

| Name | Type | Description |
| :--- | :--- | :--- |
| `index.md` | File | Starting point (a.k.a. "home page") for your wiki. **Note this is not the `index.html`, but `index.md`**! |
| `navigation.md` | File | Various settings of your wiki (e.g., name of your wiki, items in the navigation bar at the top, etc.) |
| `config.json` | File | If you don't know what this is for, don’t touch it. |
| `pages` | Folder | Ideally, inside this folder, you create one `*.md` file for every page inside your wiki (e.g., `foo.md`, `much-longer-names-are-also-okay.md`, etc.) You can also create as many subfolders as you need, just remember to link them accordingly. |
| `uploads` | Folder | An example folder structure where you could put other files. **Although it is best to host your files somewhere else, like Dropbox, or a CDN, etc.** |

Best Practices
--------------

### Relative URLs

Instead of using absolute URLs when linking one wiki page to another, use relative URLs.

For instance if `en/pages/foo.md` page had to link to `en/pages/bar.md`, it is enough to just add `[Click here](bar.md)` in your markdown.

### Don't Host Your Uploads in Git(Hub)

Instead of hosting your uploads inside the `uploads` folder, consider using Dropbox, Google Drive, or a CDN.

### Add References to Uploads

**Whenever you can, avoid hosting your uploads using Git(Hub).**

If you _must_ add references to files hosted inside the `uploads` folder here's how to do it, for instance: `![Image Title](uploads/images/foo.png)`. Add that in your markdown and you're good to go.


How to Preview
==============

In order to preview your changes locally, prior to publishing online, you may need to take some actions. Below some starting points for each operating system, also check out MDwiki's [frequently asked questions](http://dynalon.github.io/mdwiki/#!faq.md) section for some ideas.

Mac OS
------

The easiest way to serve up static sites on a Mac is to use [Anvil](http://anvilformac.com). Go ahead and download it from their website, install and add a site using the status bar icon: simply select the folder where your wiki is located on your Mac.

If you don't want to download any apps, you can use the Terminal on your Mac and Python. To do this, go to your site folder in the Terminal app and type `python -m SimpleHTTPServer 8000`. This will start running a local server which you can navigate to by typing the URL `localhost:8000` in any web browser.

Windows
-------

You can use [Fenix](http://fenixwebserver.com) to host a static site on windows. Fenix also comes with lots of advanced functionality that you might not use. Fenix can also run on a Mac.

Linux
-----

You can use [Prax](http://ysbaddaden.github.io/prax/). Prax is a pure ruby alternative to Pow!! that runs on GNU/Linux.


For Developers
==============

You don't need to read below here or do anything at all if you're only interested creating your own wiki. This section is for developers or maintainers of this repository.

Update MDwiki
-------------

> Current version: [0.6.2](http://git.io/HBH5Wg).

1. Go to https://github.com/Dynalon/mdwiki/releases/latest
1. Click on the green button on that page to download the latest release
1. Extract the contents of the archive file
1. Copy `mdwiki-slim.html` file from the extracted files onto `ll_CC/index.html` file in this repository by renaming, thus overriding `index.html`
1. Update the version information above
1. Commit and push your changes

You can now delete any files downloaded previously, if you want to.
- [Ngecilin](https://github.com/kulkultech/ngecilin) - A Browser Extension to shorten any URL with only 2-clicks.
- [tinyurl-client](https://github.com/kulkultech/tinyurl-client) - A Library to use TinyURL API in the Browser.
- [jumpstart-swe](https://github.com/kulkultech/jumpstart-swe) - A project to help aspiring software engineers to thrive.