Skip to content

Commit

Permalink
Merge pull request #634 from DejanMilicic/master
Browse files Browse the repository at this point in the history
Documentation started
  • Loading branch information
DejanMilicic committed May 4, 2015
2 parents 1dbe28a + 500caa0 commit 2d3f87d
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/documentation/getting-started/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
===============
Getting Started
===============

*N2CMS is a lightweight CMS framework* With just a few strokes of your keyboard a wonderful strongly typed
model emerges complete with a management UI. You can spend the rest of your day building the best site imaginable.

*It's so .NET!* With N2CMS, you build the model of the data that needs to be managed using C# or VB code in Visual Studio. The type below is picked up by the N2 engine at runtime and made available to be edited. The code uses an open API with multiple built-in options and unlimited customization options.

All you have to do is design your model class (inherit N2.ContentItem) and define which properties are editable by adding attributes

.. code-block:: c#
[PageDefinition(TemplateUrl = "~/my/pageitemtemplate.aspx")]
public class PageItem : N2.ContentItem
{
[EditableFreeTextArea]
public virtual string Text { get; set; }
}
See also: Editors via Attributes

.. toctree::
:maxdepth: 3

server-requirements.rst
84 changes: 84 additions & 0 deletions docs/documentation/getting-started/server-requirements.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
===================
Server Requirements
===================

Operating System
================

N2CMS runs on .NET Framework 4.5, which runs on the following operating systems.

*Server operating systems*

========================== ================================ ====================================================
Operating system Supported .NET Framework Version Additional information
========================== ================================ ====================================================
Win Server 2012 R2 4.5 Includes .NET Framework 4.5.1
Win Server 2012 (64-bit) 4.5 Includes .NET Framework 4.5
Win Server 2008 R2 SP1 4.0, 4.5 Supported in the Server Core Role with SP1 or later.
Win Server 2008 SP2 4.0, 4.5 Not supported in the Server Core Role.
Win Server 2003 R2 4.0, 4.5 Dinamico/N2CMS.Razor is not supported because .NET Framework 4.5 is not available.
Win Server 2003 or earlier Not supported Not supported
========================== ================================ ====================================================

Client operating systems
========================

N2CMS supports Visual Studio 2010, 2012, and 2013 on the following operating systems:

===================== ======================== ==================================
Operating system Supported editions Additional information
===================== ======================== ==================================
Windows 8.1 32-bit and 64-bit Includes the .NET Framework 4.5.1
Windows 8 32-bit and 64-bit Includes the .NET Framework 4.5
Windows 7 SP1 32-bit and 64-bit
Windows Vista SP2 32-bit and 64-bit
===================== ======================== ==================================

Web Servers
===========

N2CMS has been tested successfully on the Visual Studio embedded web server, IIS, and IIS Express.

.NET Framework
==============

N2CMS 1.5 can run on .NET 2.0. We recommend that you run N2CMS on the latest version of the .NET framework possible.

Databases
=========

Supported databases include:

* SQL Server 2008 *
* SQL Server 2008 Express *
* SQL Server 2005 *
* SQL Server 2005 Express *
* SQL Server 2000
* SqlCe
* MySQL *
* SQLite *
* Firebird
* Jet
* DB2
* Oracle9i
* Oracle10g

* A connection string example for these database engines can be found in web.config.

Wildcard mapping (IIS 5-6.1)
============================

On IIS 5 to IIS 6.1 wildcard mapping can be enabled to support “extensionless urls” (no ending .aspx on each page address). Wilcard mapping is an IIS feature that enables requests to all types of resources to pass through managed ASP.NET code. This allows N2 CMS to serve pages for pages not ending with .aspx. This is configured slightly differently depending on IIS version. Try searching and pick the version you're using: http://www.google.com/search?q=iis+wildcard+mapping

Visual Studio Development
=========================

* Visual Studio 2012 is recommended for site development with N2CMS.
* Visual Studio Express can also be used.

Visual Studio 2012 project files are included in the N2CMS source tree.

Shared Hosting
==============

Some users report no problems running in shared hosting under medium trust, others have had problems. N2CMS has been tested on unmodified medium trust. It’s recommended you ask the hosting provider before you buy a long-term plan. Note that N2CMS can be somewhat RAM intensive, and requires a minimum of 64 MB of RAM dedicated to your website. More RAM may be needed depending on the plugins you require or the amount of traffic your website receives. Plug-ins such as site search can also increase the memory requirement.
Binary file added docs/documentation/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Welcome to N2CMS documentation!
===================================

.. image:: documentation/logo.png

N2 is a lightweight CMS framework to help you build great web sites that anyone can update. Using its
interface is intuitive and empowering. The developer story is something exquisite. Give it a try and
you'll see.

.. toctree::
:maxdepth: 3

documentation/getting-started/index.rst

0 comments on commit 2d3f87d

Please sign in to comment.