Advanced Search
Search Results
45 total results found
Page
Pages take their name from the original concept of a Hyper Text Page, the ancestor to the Web Page we know today. Similar to basic web pages, wiki pages are meant to act as a single document in a larger cluster of documents. Wikipedia pages, for example, are d...
Chapter
A chapter are an optional way to further organize the pages inside a book. Chapters act as a way to bundle a set of pages together into a drop-down menu in most interfaces. This is mostly used for categorization, and rarely altering permissions in advanced set...
Book
Books are the name-sake of Bookstack, acting as a binding to bring together several pages and chapters into an explicit order, complete with fine grained permissions, covers, and portability. At their base structure a book is a topic with many moving parts, an...
Shelf
Shelves are very broad topics which themselves take multiple books to detail. Shelves hold no information themselves, but allow shelf maintainers to add and remove books, or make new books, to achieve the goal of whatever the shelf aims to achieve. Shelfs are ...
Permissions
All 4 kinds of information organizing (Pages, Chapters, Books, and Shelves) have a permissions system. For Books, Chapters, changes to their permissions will effect anything that is binded by that book or chapter. Shelves do not have this effect on books, with...
Revisions
Each page has a version history built in which allows you to see what each person has left on the page. All the changes made on each edit are public information for anyone with viewing power. These version are made every time a page is saved. Viewing Revisions...
Comments
Each page can be commented by anyone with the ability to alter it. These comments are treated separately from the content of the page, and can be used to coordinate changes or revisions of the page content. You can find the comments section at the bottom of ea...
Basic Navigation (Desktop)
Bookstack's layout can be split into 5 sectors Red - Navigation Bar. This will allow you to navigate to the main important locations in the website: the Shelves, the Books, your personal settings and your account. The search bar will search all text in the wik...
Making a New Local Repository
Making a new Git repository means just making an empty timeline with nothing it in, including not initial version. After you create the new local repository, it's usually considered a good idea to take any files you already have, stage all of them, and commit ...
Downloading an Existing Repository
If a repository already exists somewhere else remotely, and you want to add a local copy of it to work on to your machine, you can use the clone sub command. When you use it, a new sub-folder will be created, and inside you will have the source code (position...
Pushing Local Changes to Remote Repository
When a branch in your local repository has had new changes made, you need to sync those changes back to the remote repository so that others can see the work done. This can be done with the push sub command, which takes all commits made locally onto a branch,...
Pulling Remote Changes to Local Repository
When changes have been put in the remote repository that you don't have in your local repository, you'll need to sync the changes into your local repository. This can be done with the pull sub command, which takes all commits made to the remote repository's b...
Staging Files
Add Files to Staging Area To take changes from your Working Directory and copy them into the Staging Area you use the add subcommand with the path of the file you want to stage, like this: git add /path/to/file This will put the changes to the file in the sta...
Committing Staged Changes
It's always a good idea to check your staging area before commiting it to the repository. You can do that by running git status. To make a commit out of staged changes and then put that commit into the repository, you can use the commit sub command. The com...
Repositories
Repositories already have a meaning from Git, but they have an expanded meaning when it comes to Forges. For Forges a repository is a Git Repository, along with all organizational tools used to manage development of the Git Repository. All aspects that I will ...
Issues
Issues, similar to Pull Requests, have old names they have somewhat outgrown. Traditionally, Issues would be things like bug reports, literal issues with a program. Currently, issues are much closer to anything that is an "issue" with how the program functions...
Pull Requests
The beating heart of open source projects, a Pull Request is a submission of commits to a Forge repository with the hope that it's changes will be merged in. In complete technicality, a Pull Request is when someone makes a branch from the main branch of a Forg...
Releases
Git Repositories often only contain source code, or non-ready-to-use information. This means that the repository itself does not include the actual runnable programs that the repository is being used to make. Additionally, since not all commits will necessaril...