Giter Site home page Giter Site logo

cim's Introduction

CONTENTS OF THIS FILE
---------------------

 * About Drupal
 * Configuration and features
 * Installation profiles
 * Appearance
 * Developing for Drupal

ABOUT DRUPAL
------------

Drupal is an open source content management platform supporting a variety of
websites ranging from personal weblogs to large community-driven websites. For
more information, see the Drupal website at http://drupal.org/, and join the
Drupal community at http://drupal.org/community.

Legal information about Drupal:
 * Know your rights when using Drupal:
   See LICENSE.txt in the same directory as this document.
 * Learn about the Drupal trademark and logo policy:
   http://drupal.com/trademark

CONFIGURATION AND FEATURES
--------------------------

Drupal core (what you get when you download and extract a drupal-x.y.tar.gz or
drupal-x.y.zip file from http://drupal.org/project/drupal) has what you need to
get started with your website. It includes several modules (extensions that add
functionality) for common website features, such as managing content, user
accounts, image uploading, and search. Core comes with many options that allow
site-specific configuration. In addition to the core modules, there are
thousands of contributed modules (for functionality not included with Drupal
core) available for download.

More about configuration:
 * Install, upgrade, and maintain Drupal:
   See INSTALL.txt and UPGRADE.txt in the same directory as this document.
 * Learn about how to use Drupal to create your site:
   http://drupal.org/documentation
 * Download contributed modules to sites/all/modules to extend Drupal's
   functionality:
   http://drupal.org/project/modules
 * See also: "Developing for Drupal" for writing your own modules, below.

INSTALLATION PROFILES
---------------------

Installation profiles define additional steps (such as enabling modules,
defining content types, etc.) that run after the base installation provided
by core when Drupal is first installed. There are two basic installation
profiles provided with Drupal core.

Installation profiles from the Drupal community modify the installation process
to provide a website for a specific use case, such as a CMS for media
publishers, a web-based project tracking tool, or a full-fledged CRM for
non-profit organizations raising money and accepting donations. They can be
distributed as bare installation profiles or as "distributions". Distributions
include Drupal core, the installation profile, and all other required
extensions, such as contributed and custom modules, themes, and third-party
libraries. Bare installation profiles require you to download Drupal Core and
the required extensions separately; place the downloaded profile in the
/profiles directory before you start the installation process. Note that the
contents of this directory may be overwritten during updates of Drupal core;
it is advised to keep code backups or use a version control system.

Additionally, modules and themes may be placed inside subdirectories in a
specific installation profile such as profiles/your_site_profile/modules and
profiles/your_site_profile/themes respectively to restrict their usage to only
sites that were installed with that specific profile.

More about installation profiles and distributions:
 * Read about the difference between installation profiles and distributions:
   http://drupal.org/node/1089736
 * Download contributed installation profiles and distributions:
   http://drupal.org/project/distributions
 * Develop your own installation profile or distribution:
   http://drupal.org/developing/distributions

APPEARANCE
----------

In Drupal, the appearance of your site is set by the theme (themes are
extensions that set fonts, colors, and layout). Drupal core comes with several
themes. More themes are available for download, and you can also create your own
custom theme.

More about themes:
 * Download contributed themes to sites/all/themes to modify Drupal's
   appearance:
   http://drupal.org/project/themes
 * Develop your own theme:
   http://drupal.org/documentation/theme

DEVELOPING FOR DRUPAL
---------------------

Drupal contains an extensive API that allows you to add to and modify the
functionality of your site. The API consists of "hooks", which allow modules to
react to system events and customize Drupal's behavior, and functions that
standardize common operations such as database queries and form generation. The
flexible hook architecture means that you should never need to directly modify
the files that come with Drupal core to achieve the functionality you want;
instead, functionality modifications take the form of modules.

When you need new functionality for your Drupal site, search for existing
contributed modules. If you find a module that matches except for a bug or an
additional needed feature, change the module and contribute your improvements
back to the project in the form of a "patch". Create new custom modules only
when nothing existing comes close to what you need.

More about developing:
 * Search for existing contributed modules:
   http://drupal.org/project/modules
 * Contribute a patch:
   http://drupal.org/patch/submit
 * Develop your own module:
   http://drupal.org/developing/modules
 * Follow best practices:
   http://drupal.org/best-practices
 * Refer to the API documentation:
   http://api.drupal.org/api/drupal/7

cim's People

Contributors

xendk avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

cim's Issues

Encryption of communication

As the configuration can contain sensitive information, it must be protected from prying eyes.

While requiring the server to support SSL could be a solution, it's not good enough as it raises the bar for the end users, and we want to keep that as low as humanly possible.

So, some possibilities:
mcrypt
openssl (simple example in here: http://stackoverflow.com/questions/1391132/two-way-encryption-in-php )

The question is how widespread those PHP modules are.

Pure PHP lib: http://phpseclib.sourceforge.net/ (with fallback to mcrypt/openssl, if they're available).
PEAR packages: http://pear.php.net/packages.php?catpid=6

Split out code into more files.

Split admin pages dealing with upstream out from pages dealing with local snapshots.

Split out XMLRPC server stuff out from client code.

Debug logging

Debug logging of communication would be very nice.

Revert a snapshot

Administrators shoud be able to revert the changes in a single snapshot.

Interface on master for receiving changeset from client.

Checking if the changeset is valid (Changeset::appliesTo()), rejecting it if not, or applying it otherwise (creating a new snapshot in the process).

Thinking XMLRPC is the straitforward protocol to use (we don't want external dependencies).

Way for dev site to hook up with prod/stg

Should be as easy as entering the URL of the master, which initiates a FB/Twitter/Google like 'app authentication' where the user is redirected to a login on the master (or skipping directly to the next step if already logged in), and being asked to confirm the hookup (if the user have the appropiate permissions, of course).

There'll be some key exchange done in the background for future communication, but it's important to remember that the client might only be reachable from the local machine (we assume that the client can always communicate with the master), so callbacks from the master is not an option.

Pushing should leave local changes in place.

Currently local changes get incorporated into the newly created snapshot. They should be reverted before snapshotting, and reapplyed afterwards. Or more elegantly be ignored in the applying of the pushed changeset stage.

Creating a client changeset

From the difference between the last fetched master snapshot and the current client configuration, and pushing it to the master.

Rebase

When configuration has changed on upstream, there needs to be a way to pull the changes, but retain local changens.

After a push, downstream is out of sync

It still thinks that the upstream is at the previous sha.

Current know upstream sha is together with the local sha that gives the same configuration. However, currently it pushes all local changes, including those that haven't been snapshottet yet, so no local snapshot may exist.

Automatically creating a snapshot could fix it, but I'm not too fond of that.

Only pushing "up to" a given snapshot is another solution, but the UI needs to be tight, so it's obvious that it's "up to", and not just the given changeset. Both options could be handy, but the possibility for confusion is great (the difference between pushing a changeset and a snapshot is small).

Clean up terminology

We don't want the features situation where we have "feature components" and "feature sources" and code that unclear on what's it's referring to.... Starting point:

  • Difference
    • One change of a config item.
  • Changeset
    • A set of Differences.
    • Has a parent changeset.
    • Has an identifier (should it be renamed to SHA?).
  • Snapshot (doesn't exist as an object, yet).
    • Contains a changeset
    • Possibly a full dump.
    • Date, maybe comment.
    • Should rename id and parent to changeset_id/parent, to avoid misunderstanding.
  • SnapshotController
    • Keeps track of snapshots.

Needs work:

  • SnapshotInterface
    • Not really an interface to snapshot.
  • ArraySnapshot
    • Something different from the snapshots managed by the controller.
  • Config
    • Bit too general a name.

SnapshotInterface -> ConfigInterface
ArraySnapshot -> ConfigArray
Config -> ConfigDrupalConfig (must avoid confusion with the DrupalConfig class).
perhaps?

And everything should be namespaced or prefixed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.